3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-03 03:12:35 +02:00
Code Issues Projects Releases Packages Wiki Activity

Deploy website

Browse source 
Deploy website version based on 6b2f57c29c
This commit is contained in:
Website Deployment Script 2018-06-10 19:21:05 +00:00
parent 6b2f57c29c
commit 4546c36b7d
368 changed files with 25613 additions and 1429 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/tr/site-config.html
View file

@ -12,7 +12,7 @@
{"zIndex":100}
)
});
</script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/></head><body class="sideNavVisible doc separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/tr"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitleWithLogo">Docusaurus</h2></a><a href="/tr/versions"><h3>1.1.5</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/tr/installation" target="_self">Dokümanlar</a></li><li class=""><a href="/tr/help" target="_self">Yardım</a></li><li class=""><a href="/tr/users" target="_self">Users</a></li><li class=""><a href="/tr/about-slash" target="_self">About /</a></li><li class=""><a href="/blog" target="_self">Blog</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_self">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg"/>Türkçe</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/en/site-config">English</a></li><li><a href="/docs/es-ES/site-config">Español</a></li><li><a href="/docs/ro/site-config">Română</a></li><li><a href="/docs/zh-CN/site-config">简体中文</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">Help Translate</a></li></ul></div></li><script>
</script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/></head><body class="sideNavVisible doc separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/tr"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitleWithLogo">Docusaurus</h2></a><a href="/tr/versions"><h3>1.2.0</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/tr/installation" target="_self">Dokümanlar</a></li><li class=""><a href="/tr/help" target="_self">Yardım</a></li><li class=""><a href="/tr/users" target="_self">Users</a></li><li class=""><a href="/tr/about-slash" target="_self">About /</a></li><li class=""><a href="/blog" target="_self">Blog</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_self">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg"/>Türkçe</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/en/site-config">English</a></li><li><a href="/docs/es-ES/site-config">Español</a></li><li><a href="/docs/ro/site-config">Română</a></li><li><a href="/docs/zh-CN/site-config">简体中文</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">Help Translate</a></li></ul></div></li><script>
const languagesMenuItem = document.getElementById("languages-menu");
const languagesDropDown = document.getElementById("languages-dropdown");
languagesMenuItem.addEventListener("click", function(){
@ -60,8 +60,8 @@
<li>Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer <code>$myColor</code> olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse <code>myColor</code> alanına <code>colors</code> eklemek bu rengin kolayca yapılandırılmasını sağlar.</li>
</ul>
<p><code>copyright</code> - The copyright string at footer of site and within feed</p>
<p><code>favicon</code> - Kısayol simgesi için url.</p>
<p><code>headerIcon</code> - Başlık gezinme çubuğunda kullanılan simge için url.</p>
<p><code>favicon</code> - URL for site favicon.</p>
<p><code>headerIcon</code> - URL for icon used in header navigation bar.</p>
<p><code>headerLinks</code> - Links that will be used in the header navigation bar. The <code>label</code> field of each object will be the link text and will also be translated for each language.</p>
<p>Örnek Kullanım:</p>
<pre><code class="hljs css languages- js">headerLinks: [
@ -81,10 +81,10 @@
</code></pre>
<p><code>noIndex</code> - Boolean. If true, Docusaurus will politely ask crawlers and search engines to avoid indexing your site. This is done with a header tag and so only applies to docs and pages. Will not attempt to hide static resources. This is a best effort request. Malicious crawlers can and will still index your site.</p>
<p><code>organizationName</code> - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.</p>
<p><code>projectName</code> - Project name. This must match your GitHub repo project name (case sensitive).</p>
<p><code>projectName</code> - Project name. This must match your GitHub repository project name (case-sensitive).</p>
<p><code>tagline</code> - Web siteniz için slogan.</p>
<p><code>title</code> - Web siteniz için başlık.</p>
<p><code>url</code> - url for your site.</p>
<p><code>url</code> - URL for your website.</p>
<h3><a class="anchor" aria-hidden="true" id="i-steğe-bağlı-alanlar"></a><a href="#i-steğe-bağlı-alanlar" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>İsteğe Bağlı Alanlar</h3>
<p><code>algolia</code> - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (<code>appId</code>) is optional.</p>
<ul>
@ -93,8 +93,9 @@
<li><code>appId</code> - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.</li>
</ul>
<p><code>blogSidebarCount</code> - Control the number of blog posts that show up in the sidebar. See the <a href="/docs/tr/blog#changing-how-many-blog-posts-show-on-sidebar">adding a blog docs</a> for more information.</p>
<p><code>cname</code> - The CNAME for your website. It will go into a <code>CNAME</code> file when your site it built.</p>
<p><code>customDocsPath</code> - By default, Docusaurus expects your documentation to be in a directory called <code>docs</code>. This directory is at the same level as the <code>website</code> directory (i.e., not inside the <code>website</code> directory). You can specify a custom path to your documentation with this field. <strong>Note that all of your documentation <code>*.md</code> files must still reside in a flat hierarchy. You cannot have your documents in nested directories</strong>.</p>
<p><code>cleanUrl</code> - If <code>true</code>, allow URLs with no <code>html</code> extension. For example, a request to URL <a href="https://docusaurus.io/docs/installation">https://docusaurus.io/docs/installation</a> will returns the same result as <a href="https://docusaurus.io/docs/installation.html">https://docusaurus.io/docs/installation.html</a>.</p>
<p><code>cname</code> - The CNAME for your website. It will go into a <code>CNAME</code> file when your site is built.</p>
<p><code>customDocsPath</code> - By default, Docusaurus expects your documentation to be in a directory called <code>docs</code>. This directory is at the same level as the <code>website</code> directory (i.e., not inside the <code>website</code> directory). You can specify a custom path to your documentation with this field.</p>
<pre><code class="hljs css languages- js">customDocsPath: <span class="hljs-string">'docs/site'</span>;
</code></pre>
<pre><code class="hljs css languages- js">customDocsPath: <span class="hljs-string">'website-docs'</span>;
@ -102,11 +103,11 @@
<p><code>defaultVersionShown</code> - The default version for the site to be shown. If this is not set, the latest version will be shown.</p>
<p><code>disableHeaderTitle</code> - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to <code>true</code>.</p>
<p><code>disableTitleTagline</code> - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as <code>Title • Tagline</code>. Set to <code>true</code> to make page titles just <code>Title</code>.</p>
<p><code>editUrl</code> - url for editing docs, usage example: <code>editUrl + 'en/doc1.md'</code>. If this field is omitted, there will be no &quot;Edit this Doc&quot; button for each document.</p>
<p><code>editUrl</code> - URL for editing docs, usage example: <code>editUrl + 'en/doc1.md'</code>. If this field is omitted, there will be no &quot;Edit this Doc&quot; button for each document.</p>
<p><code>facebookAppId</code> - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a <a href="https://www.facebook.com/help/audiencenetwork/804209223039296">Facebook application id</a>.</p>
<p><code>facebookComments</code> - Set this to <code>true</code> if you want to enable Facebook comments at the bottom of your blog post. <code>facebookAppId</code> has to be also set.</p>
<p><code>facebookPixelId</code> - <a href="https://www.facebook.com/business/a/facebook-pixel">Facebook Pixel</a> ID to track page views.</p>
<p><code>fonts</code> - Font-family css configuration for the site. If a font family is specified in <code>siteConfig.js</code> as <code>$myFont</code>, then adding a <code>myFont</code> key to an array in <code>fonts</code> will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.</p>
<p><code>fonts</code> - Font-family CSS configuration for the site. If a font family is specified in <code>siteConfig.js</code> as <code>$myFont</code>, then adding a <code>myFont</code> key to an array in <code>fonts</code> will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.</p>
<p>In the below example, we have two sets of font configurations, <code>myFont</code> and <code>myOtherFont</code>. <code>Times New Roman</code> is the preferred font in <code>myFont</code>. <code>-apple-system</code> is the preferred in <code>myOtherFont</code>.</p>
<pre><code class="hljs css languages- js">fonts: {
<span class="hljs-attr">myFont</span>: [
@ -127,6 +128,7 @@
<p><code>footerIcon</code> - URL for a footer icon. Currently used in the <code>core/Footer.js</code> file provided as an example, but it can be removed from that file.</p>
<p><code>gaTrackingId</code> - Google Analytics tracking ID to track page views.</p>
<p><code>gaGtag</code> - Set this to <code>true</code> if you want to use <a href="https://developers.google.com/gtagjs/">global site tags (gtag.js)</a> for Google analytics instead of <code>analytics.js</code>.</p>
<p><code>githubHost</code> - Hostname of your server. Useful if you are using GitHub Enterprise.</p>
<p><code>highlight</code> - <a href="/docs/tr/doc-markdown">Syntax highlighting</a> options:</p>
<ul>
<li><code>theme</code> is the name of the theme used by Highlight.js when highlighting code. You can find the <a href="https://github.com/isagalaev/highlight.js/tree/master/src/styles">list of supported themes here</a>.</li>
@ -142,7 +144,9 @@
<li><code>separate</code> - The secondary navigation is a separate pane defaulting on the right side of a document. See <a href="http://docusaurus.io/docs/en/translation.html">http://docusaurus.io/docs/en/translation.html</a> for an example.</li>
</ul>
<p><code>scripts</code> - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.</p>
<p><code>separateCss</code> - Folders inside which any <code>css</code> files will not be processed and concatenated to Docusaurus' styles. This is to support static <code>html</code> pages that may be separate from Docusaurus with completely separate styles.</p>
<p><code>separateCss</code> - Directories inside which any <code>css</code> files will not be processed and concatenated to Docusaurus' styles. This is to support static <code>html</code> pages that may be separate from Docusaurus with completely separate styles.</p>
<p><code>scrollToTop</code> - Set this to <code>true</code> if you want to enable the scroll to top button at the bottom of your site.</p>
<p><code>scrollToTopOptions</code> - Optional options configuration for the scroll to top button. You do not need to use this, even if you set <code>scrollToTop</code> to <code>true</code>; it just provides you more configuration control of the button. You can find more options <a href="https://github.com/vfeskov/vanilla-back-to-top/blob/v7.1.14/OPTIONS.md">here</a>. By default, we set the zIndex option to 100.</p>
<p><code>stylesheets</code> - Array of CSS sources to load. The link tag will be inserted in the HTML head.</p>
<p><code>translationRecruitingLink</code> - URL for the <code>Help Translate</code> tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.</p>
<p><code>twitter</code> - Set this to <code>true</code> if you want a Twitter social button to appear at the bottom of your blog posts.</p>
@ -150,6 +154,7 @@
<p><code>twitterImage</code> - Local path to your Twitter card image (e.g., <code>img/myImage.png</code>). This image will show up on the Twitter card when your site is shared on Twitter.</p>
<p><code>useEnglishUrl</code> - If you do not have <a href="/docs/tr/translation">translations</a> enabled (e.g., by having a <code>languages.js</code> file), but still want a link of the form <code>/docs/en/doc.html</code> (with the <code>en</code>), set this to <code>true</code>.</p>
<p><code>users</code> - The <code>users</code> array mentioned earlier.</p>
<p><code>usePrism</code> - Array of languages to use Prism syntax highlighter. Refer to <a href="/docs/tr/doc-markdown#using-prism-as-additional-syntax-highlighter">Using Prism as additional syntax highlighter</a>. Set it to <code>true</code> to use Prism on all languages.</p>
<p><code>wrapPagesHTML</code> - Boolean flag to indicate whether <code>html</code> files in <code>/pages</code> should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being <code>html</code> fragments instead of complete pages. It inserts the contents of your <code>html</code> file with no extra processing. Defaults to <code>false</code>.</p>
<p>Users can also add their own custom fields if they wish to provide some data across different files.</p>
<h2><a class="anchor" aria-hidden="true" id="example-siteconfigjs-with-many-available-fields"></a><a href="#example-siteconfigjs-with-many-available-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Example siteConfig.js with many available fields</h2>
@ -167,7 +172,7 @@
<span class="hljs-attr">tagline</span>: <span class="hljs-string">'Generate websites!'</span>,
<span class="hljs-attr">url</span>: <span class="hljs-string">'https://docusaurus.io'</span>,
<span class="hljs-attr">baseUrl</span>: <span class="hljs-string">'/'</span>,
<span class="hljs-comment">// For github.io type URLS, you would combine the url and baseUrl like:</span>
<span class="hljs-comment">// For github.io type URLS, you would combine the URL and baseUrl like:</span>
<span class="hljs-comment">// url: 'https://reasonml.github.io',</span>
<span class="hljs-comment">// baseUrl: '/reason-react/',</span>
defaultVersionShown: <span class="hljs-string">'1.0.0'</span>,
@ -225,6 +230,11 @@
<span class="hljs-attr">twitterUsername</span>: <span class="hljs-string">'docusaurus'</span>,
<span class="hljs-attr">twitterImage</span>: <span class="hljs-string">'img/docusaurus.png'</span>,
<span class="hljs-attr">ogImage</span>: <span class="hljs-string">'img/docusaurus.png'</span>,
<span class="hljs-attr">cleanUrl</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">scrollToTop</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">scrollToTopOptions</span>: {
<span class="hljs-attr">zIndex</span>: <span class="hljs-number">100</span>,
},
};
<span class="hljs-built_in">module</span>.exports = siteConfig;