diff --git a/website/pages/en/versions.js b/website/pages/en/versions.js new file mode 100644 index 0000000000..1bbc3b94a2 --- /dev/null +++ b/website/pages/en/versions.js @@ -0,0 +1,105 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const React = require('react'); + +const CompLibrary = require('../../core/CompLibrary'); +const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock; + +const CWD = process.cwd(); + +const siteConfig = require(CWD + '/siteConfig.js'); +const versions = require(CWD + '/versions.json'); + +class Versions extends React.Component { + render() { + const latestVersion = versions[0]; + return ( +
+ +
+
+

{siteConfig.title + ' Versions'}

+
+

Current version (Stable)

+

Latest version of Docusaurus.

+ + + + + + + + +
{latestVersion} + Documentation + + Release Notes +
+

Latest Version

+ Here you can find the latest documentation and unreleased code. + + + + + + + + +
master + + Documentation + + + Source Code +
+

Past Versions

+

Here you can find documentation for previous versions of Docusaurus.

+ + + {versions.map( + version => + version !== latestVersion && ( + + + + + + ) + )} + +
{version} + + Documentation + + + + Release Notes + +
+

+ You can find past versions of this project{' '} + on GitHub . +

+
+ +
+ ); + } +} + +module.exports = Versions; diff --git a/website/versioned_docs/version-1.0.11/api-commands.md b/website/versioned_docs/version-1.0.11/api-commands.md new file mode 100644 index 0000000000..f9eee77ec7 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/api-commands.md @@ -0,0 +1,131 @@ +--- +id: version-1.0.11-commands +title: CLI Commands +original_id: commands +--- + +Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the `run` command when using Yarn or npm. Some common commands are: + +* [`yarn run start`](api-commands.md#docusaurus-start-port-number): build and serve the website from a local server +* [`yarn run examples`](api-commands.md#docusaurus-examples): create example configuration files + + +## Running from the command line + +The scripts can be run using either Yarn or npm. If you've already gone through our Getting Started guide, you may already be familiar with the `start` command. It's the command that tells Docusaurus to run the `docusaurus-start` script which generates the site and starts up a server, and it's usually invoked like so: + +``` +yarn run start +``` + +The same script can be invoked using npm: + +``` +npm run start +``` + +To run a particular script, just replace the `start` command in the examples above with the command associated with your script. + +## Using arguments + +Some commands support optional arguments. For example, to start a server on port 8080, you can specify the `--port` argument when running `start`: + +``` +yarn run start --port 8080 +``` + +If you run Docusaurus using npm, you can still use the command line arguments by inserting a `--` between `npm run ` and the command arguments: + +``` +npm run start -- --port 8080 +``` + +## Configuration + +These scripts are set up under the `"scripts"` key in your `website/package.json` file as part of the installation process. If you need help setting them up again, please refer to the [Installation guide](getting-started-installation.md). + +Docusaurus provides some default mappings to allow you to run commands following Node conventions. Instead of typing `docusaurus-start` every time, you can type `yarn run start` or `npm start` to achieve the same. + +## Commands + + + +----- + +## Reference + +### `docusaurus-build` +Alias: `build`. + +Generates the static website, applying translations if necessary. Useful for building the website prior to deployment. + +See also [`docusaurus-start`](api-commands.md#docusaurus-start-port-number). + +--- + +### `docusaurus-examples [feature]` +Alias: `examples` + +When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the [Site Preparation guide](getting-started-preparation.md). Specify a feature `translations` or `versions` to generate the extra example files for that feature. + +--- + +### `docusaurus-publish` +Alias: `publish-gh-pages` + +[Builds](api-commands.md#docusaurus-build), then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined: + +The following environment variables are generally set manually by the user in the CircleCI `config.yml` file. + + - `GIT_USER`: The git user to be associated with the deploy commit. + - `USE_SSH`: Whether to use SSH instead of HTTPS for your connection to the GitHub repo. + + e.g., + + ```bash + GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages + ``` + +The following environment variables are [set by CircleCI](https://circleci.com/docs/1.0/environment-variables/) during the build process. + + - `CIRCLE_BRANCH`: The git branch associated with the commit that triggered the CI run. + - `CI_PULL_REQUEST`: Expected to be truthy if the current CI run was triggered by a commit in a pull request. + +The following should be set by you in `siteConfig.js` as `organizationName` and `projectName`, respectively. If they are not set in your site configuration, they fall back to the [CircleCI environment](https://circleci.com/docs/1.0/environment-variables/). + + - `CIRCLE_PROJECT_USERNAME`: The GitHub username or organization name that hosts the Git repo, e.g. "facebook". + - `CIRCLE_PROJECT_REPONAME`: The name of the Git repo, e.g. "Docusaurus". + +You can learn more about configuring automatic deployments with CircleCI in the [Publishing guide](getting-started-publishing.md). + +--- + +### `docusaurus-rename-version ` +Alias: `rename-version` + +Renames an existing version of the docs to a new version name. + +See the [Versioning guide](guides-versioning.md#renaming-existing-versions) to learn more. + +--- + +### `docusaurus-start [--port ]` +Alias: `start`. + +This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default. + +--- + +### `docusaurus-version ` +Alias: `version` + +Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number. + +See the [Versioning guide](guides-versioning.md) to learn more. + +--- + +### `docusaurus-write-translations` +Alias: `write-translations` + +Writes the English for any strings that need to be translated into an `website/i18n/en.json` file. The script will go through every file in `website/pages/en` and through the `siteConfig.js` file and other config files to fetch English strings that will then be translated on Crowdin. See the [Translation guide](guides-translation.md) to learn more. diff --git a/website/versioned_docs/version-1.0.11/api-doc-markdown.md b/website/versioned_docs/version-1.0.11/api-doc-markdown.md new file mode 100644 index 0000000000..fa64cdd627 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/api-doc-markdown.md @@ -0,0 +1,178 @@ +--- +id: version-1.0.11-doc-markdown +title: Markdown Features +original_id: doc-markdown +--- + +## Markdown Headers + +### Documents + +Documents use the following markdown header fields that are enclosed by a line `---` on either side: + +`id`: A unique document id. If this field is not present, the document's `id` will default to its file name (without the extension). + +`title`: The title of your document. If this field is not present, the document's `title` will default to its `id`. + +`hide_title`: Whether to hide the title at the top of the doc. + +`sidebar_label`: The text shown in the document sidebar for this document. If this field is not present, the document's `sidebar_label` will default to its `title`. + +For example: + +```markdown +--- +id: doc1 +title: My Document +sidebar_label: Document +--- +``` + +Versioned documents have their ids altered to include the version number when they get copied. The new `id` is `version-${version}-${id}` where `${version}` is the version number of that document and `${id}` is the original `id`. Additionally, versioned documents get an added `original_id` field with the original document id. + +For example: + +```markdown +--- +id: version-1.0.0-doc1 +title: My Document +sidebar_label: Document +original_id: doc1 +--- +``` + +`custom_edit_url`: The url for editing this document. If this field is not present, the document's edit url will fallback to `editUrl` from optional fields of `siteConfig.js`. See [siteConfig.js](site-config.md) docs for more information. + +For example: + +```markdown +--- +id: doc-markdown +title: Markdown Features +custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md +--- +``` + +### Blog Posts + +Blog Posts use the following markdown header fields that are enclosed by a line `---` on either side: + +`title`: The title of this blog post. + +`author`: The author of this blog post. If this field is omitted, no author name will be shown. + +`authorURL`: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything. + +`authorFBID`: The author's Facebook id, used only to get the author's profile picture to display with the blog post. If this field is omitted, no author picture will be shown for the blog post. + +For example: + +```markdown +--- +title: My First Blog Post +author: Frank Li +authorURL: http://twitter.com/franchementli +authorFBID: 100002976521003 +--- +``` + +## Extra Features + +Docusaurus supports some extra features when writing documentation in markdown. + +### Linking other Documents + +You can use relative urls to other documentation files which will automatically get converted to the corresponding html links when they get rendered. + +Example: + +```markdown +[This links to another document](other-document.md) +``` +This markdown will automatically get converted into a link to `/docs/other-document.html` (or the appropriately translated/versioned link) once it gets rendered. + +This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct html links when they get rendered. + +### Linking to Images and Other Assets + +Static assets can be linked to in the same way that documents are, using relative urls. Static assets used in documents and blogs should go into `docs/assets` and `website/blog/assets`, respectively. The markdown will get converted into correct link paths so that these paths will work for documents of all languages and versions. + +Example: + +```markdown +![alt-text](assets/doc-image.png) +``` + + +### Generating Table of Contents + +You can make an autogenerated list of links, which can be useful as a table of contents for API docs. + +In your markdown file, insert a line with the text <`AUTOGENERATED_TABLE_OF_CONTENTS`>. Write your documentation using `h3` headers for each function inside a code block. These will be found by Docusaurus and a list of links to these sections will inserted at the text <`AUTOGENERATED_TABLE_OF_CONTENTS`>. + +Example: + +```markdown +### `docusaurus.function(a, b)` + +Text describing my function + + +### `docdoc(file)` + +Text describing my function +``` + +will lead to a table of contents of the functions: + +```markdown +- `docusaurus.function(a, b)` +- `docdoc(file)` +``` + +and each function will link to their corresponding sections in the page. + +## Syntax Highlighting + +Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an [info string](https://github.github.com/gfm/#example-111), following the three opening backticks. The following JavaScript example... + + ```javascript + ReactDOM.render( +

Hello, world!

, + document.getElementById('root') + ); + ``` + +...would be rendered with syntax highlighting like so: + +```javascript +ReactDOM.render( +

Hello, world!

, + document.getElementById('root') +); +``` + +Highlighting is provided by [Highlight.js](https://highlightjs.org) using the theme specified in your `siteConfig.js` file as part of the `highlight` key: + +```javascript +highlight: { + theme: 'default' +} +``` + +You can find the full list of supported themes in the Highlight.js [`styles`](https://github.com/isagalaev/highlight.js/tree/master/src/styles) directory. + +### Registering additional languages + +While Highlight.js provides support for [many popular languages out of the box](https://highlightjs.org/static/demo/), you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the `hljs` constant as part of the `highlight` config key. This in turn allows you to call [`registerLanguage`](http://highlightjs.readthedocs.io/en/latest/api.html#registerlanguage-name-language): + +```javascript +highlight: { + theme: 'default', + hljs: function(hljs) { + hljs.registerLanguage('galacticbasic', function(hljs) { + // ... + }); + } +} +``` diff --git a/website/versioned_docs/version-1.0.11/api-pages.md b/website/versioned_docs/version-1.0.11/api-pages.md new file mode 100644 index 0000000000..d017309f23 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/api-pages.md @@ -0,0 +1,153 @@ +--- +id: version-1.0.11-api-pages +title: Pages and Styles +original_id: api-pages +--- + +Docusaurus provides support for writing pages as React components inside the `website/pages` folder which will share the same header, footer, and styles as the rest of the site. + +## Urls for Pages + +Any `.js` files in `website/pages` will be rendered to static html using the path of the file after "pages". Files in `website/pages/en` will also get copied out into `pages` and will OVERRIDE any files of the same name in `pages`. For example, the page for the `website/pages/en/help.js` file will be found at the url `${baseUrl}en/help.js` as well as the url `${baseUrl}help.js`, where `${baseUrl}` is the `baseUrl` field set in your [siteConfig.js file](api-site-config.md). + + +## Page Require Paths + +Docusaurus provides a few useful React components for users to write their own pages, found in the `CompLibrary` module. This module is provided as part of Docusaurus in `node_modules/docusaurus`, so to access it, pages in the `pages` folder are temporarily copied into `node_modules/docusaurus` when rendering to static html. As seen in the example files, this means that a user page at `pages/en/index.js` uses a require path to `"../../core/CompLibrary.js"` to import the provided components. + +What this means to the user is that if you wish to use the `CompLibrary` module, make sure the require path is set correctly. For example, a page at `page/mypage.js` would use a path `"../core/CompLibrary.js"`. + +If you wish to use your own components inside the website folder, use `process.cwd()` which will refer to the `website` folder to construct require paths. For example, if you add a component to `website/core/mycomponent.js`, you can use the require path, `"process.cwd() + /core/mycomponent.js"`. + +## Provided Components + +Docusaurus provides the following components in `CompLibrary`: + +### `CompLibrary.MarkdownBlock` + +A React component that parses markdown and renders to HTML. + +Example: + +```jsx +const MarkdownBlock = CompLibrary.MarkdownBlock; + +[Markdown syntax for a link](http://www.example.com) +``` + +### `CompLibrary.Container` + +A React container component using Docusaurus styles. Has optional padding and background color props that you can configure. + +**Props** + +| Prop | Type | Default | Description | +| --- | --- | --- | --- | +| padding | Array of `'all'`, `'bottom'`, `'left'`, `'right'`, `'top'` | `[]` | Positions of the padding. | +| background | One of `'dark'`, `'highlight'`, `'light'` | `null` | Background styling of the element. | +| className | String | - | Custom class to add to the element. | + +**Example** + +```jsx + + ... + +``` + +### `CompLibrary.GridBlock` + +A React component to organize text and images. + +**Props** + +| Prop | Type | Default | Description | +| --- | --- | --- | --- | +| align | One of `'left'`, `'center'`, `'right'` | `'left'` | Text alignment of content. | +| layout | One of `'twoColumn'`, `'threeColumn'`, `'fourColumn'` | `'twoColumn'` | Number of column sections in the `GridBlock`. | +| className | String | - | Custom class to add to the element. | +| contents | Array of content objects | `[]` | Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object. | + +**Content Object** + +| Key | Type | Default | Description | +| --- | --- | --- | --- | +| title | String | - | The display title of this section, which is parsed using Markdown | +| content | String | - | The text of this section, which is parsed using Markdown | +| image | String | - | The path of the display image | +| imageAlt | String | - | The text that will be shown in case the image is not available | +| imageAlign | One of `'top'`, `'left'`, `'bottom'`, `'right'` | `'left'` | Image alignment relative to the text | +| imageLink | String | - | Link destination from clicking the image | + +**Example** + +``` + +``` + +More examples of how these components are used can be found in the [generated example files](getting-started-preparation.md) as well as in Docusaurus' own repo for its website set-up. + +## Translating Strings + +When translations are enabled, any pages inside `website/pages/en` will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the `languages.js` file. E.g. The url for a French page of `website/pages/en/help.js` would be found at `${baseUrl}fr/help.html`. + +When writing pages that you wish to translate, wrap any strings to be translated inside a `` tag. e.g., + +```jsx +

I like translations

+``` + +You can also provide an optional description attribute to provide context for translators. e.g, + +```jsx + + Community + +``` + +Add the following require statement as well: + +```js +const translate = require("../../server/translate.js").translate; +``` + +Note that this path is valid for files inside `pages/en` and should be adjusted accordingly if files are in different locations, as discussed [above](#page-require-paths). + +## Using Static Assets + +Static assets should be placed into the `website/static` folder. They can be accessed by their paths, excluding "static". For example, if the site's `baseUrl` is "/docusaurus/", an image in `website/static/img/logo.png` is available at `/docusaurus/img/logo.png`. + + +## Styles + +You should configure your site's primary, secondary, and code block colors using the `colors` field in `siteConfig` as specified [here](api-site-config.md). You can also configure other colors in the same way as described in the `siteConfig` doc. + +You can provide your own custom styles by adding them anywhere in the `website/static` folder. Any `.css` files you provide in the `static` folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish. + +An easy way to figure out what classes you wish to override or add to is to [start your server locally](api-commands.md) and use your browser's inspect element tool. diff --git a/website/versioned_docs/version-1.0.11/api-site-config.md b/website/versioned_docs/version-1.0.11/api-site-config.md new file mode 100644 index 0000000000..e60137ce66 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/api-site-config.md @@ -0,0 +1,229 @@ +--- +id: version-1.0.11-site-config +title: siteConfig.js +original_id: site-config +--- + +A large part of site configuration is done by editing the `siteConfig.js` file. + +## User Showcase + +The `users` array is used to store objects for each project/user that you want to show on your site. Currently this field is used by example the `pages/en/index.js` and `pages/en/users.js` files provided. Each user object should have `caption`, `image`, `infoLink`, and `pinned` fields. The `caption` is the text showed when someone hovers over the `image` of that user, and the `infoLink` is where clicking the image will bring someone. The `pinned` field determines whether or not it shows up on the `index` page. + +Currently this `users` array is used only by the `index.js` and `users.js` example files. If you do not wish to have a users page or show users on the `index` page, you may remove this section. + +## siteConfig Fields + +The `siteConfig` object contains the bulk of the configuration settings for your website. + +### Mandatory Fields + +`baseUrl` - baseUrl for your site. + +`colors` - Color configurations for the site. + + - `primaryColor` is the color used the header navigation bar and sidebars. + - `secondaryColor` is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile). + - Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to easily configure this color. + +`copyright` - The copyright string at footer of site and within feed + +`favicon` - url for site favicon. + +`headerIcon` - url for icon used in header navigation bar. + +`headerLinks` - Links that will be used in the header navigation bar. The `label` field of each object will be the link text and will also be translated for each language. + +Example Usage: +```js +headerLinks: [ + // Links to document with id doc1 for current language/version + { doc: "doc1", label: "Getting Started" }, + // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language + { page: "help", label: "Help" }, + // Links to href destination + { href: "https://github.com/", label: "GitHub" }, + // Links to blog generated by Docusaurus (${baseUrl}blog) + { blog: true, label: "Blog" }, + // Determines search bar position among links + { search: true }, + // Determines language drop down position among links + { languages: true } +], +``` + +`noIndex` - 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. + +`organizationName` - 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. + +`projectName` - Project name. This must match your GitHub repo project name (case sensitive). + +`tagline` - Tagline for your website. + +`title` - Title for your website. + +`url` - url for your site. + +### Optional Fields + +`algolia` - 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 (`appId`) is optional. + +- `apiKey` - the Algolia provided API key for your search. +- `indexName` - the Algolia provided index name for your search (usually this is the project name) +- `appId` - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them. + +`blogSidebarCount` - Control the number of blog posts that show up in the sidebar. See the [adding a blog docs](guides-blog.md#changing-how-many-blog-posts-show-on-sidebar) for more information. + +`cname` - The CNAME for your website. It will go into a `CNAME` file when your site it built. + +`customDocsPath` - By default, Docusaurus expects your documentation to be in a directory called `docs`. This directory is at the same level as the `website` directory (i.e., not inside the `website` directory). You can specify a custom path to your documentation with this field. **Note that all of your documentation `*.md` files must still reside in a flat hierarchy. You cannot have your documents in nested directories**. + +```js +customDocsPath: "docs/site" +``` + +```js +customDocsPath: "website-docs" +``` +`disableHeaderTitle` - 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 `true`. + +`disableTitleTagline` - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as `Title • Tagline`. Set to `true` to make page titles just `Title`. + +`editUrl` - url for editing docs, usage example: `editUrl + 'en/doc1.md'`. If this field is omitted, there will be no "Edit this Doc" button for each document. + +`facebookAppId` - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a [Facebook application id](https://www.facebook.com/help/audiencenetwork/804209223039296), and the buttons will show up on all blog posts. + +`facebookPixelId` - [Facebook Pixel](https://www.facebook.com/business/a/facebook-pixel) ID to track page views. + +`fonts` - Font-family css configuration for the site. If a font family is specified in `siteConfig.js` as `$myFont`, then adding a `myFont` key to an array in `fonts` 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. + +In the below example, we have two sets of font configurations, `myFont` and `myOtherFont`. `Times New Roman` is the preferred font in `myFont`. `-apple-system` is the preferred in `myOtherFont`. + +``` +fonts: { + myFont: [ + "Times New Roman", + "Serif" + ], + myOtherFont: [ + "-apple-system", + "system-ui" + ] +}, +``` + +The above fonts would be represented in your CSS file(s) as variables `$myFont` and `$myOtherFont`. + +``` +h1 { + font-family: $myFont; +} +``` + +`footerIcon` - url for a footer icon. Currently used in the `core/Footer.js` file provided as an example, but it can be removed from that file. + +`gaTrackingId` - Google Analytics tracking ID to track page views. + +`highlight` - [Syntax highlighting](api-doc-markdown.md) options: + + - `theme` is the name of the theme used by Highlight.js when highlighting code. You can find the [list of supported themes here](https://github.com/isagalaev/highlight.js/tree/master/src/styles). + - `version` specifies a particular version of Highlight.js to be used. + - `hljs` provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting. + - `defaultLang` defines a default language. It will be used if one is not specified at the top of the code block. You can find the [list of supported languages here](https://github.com/isagalaev/highlight.js/tree/master/src/languages). + +`markdownPlugins` - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined. + +`ogImage` - url for an Open Graph image. This image will show up when your site is shared on Facebook, Twitter and any other websites/apps where the Open Graph protocol is supported. + +`onPageNav` - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option: + +- `separate` - The secondary navigation is a separate pane defaulting on the right side of a document. See http://docusaurus.io/docs/en/translation.html for an example. + +`scripts` - Array of JavaScript sources to load. The script tag will be inserted in the HTML head. + +`separateCss` - Folders inside which any `css` files will not be processed and concatenated to Docusaurus' styles. This is to support static `html` pages that may be separate from Docusaurus with completely separate styles. + +`stylesheets` - Array of CSS sources to load. The link tag will be inserted in the HTML head. + +`translationRecruitingLink` - url for the `Help Translate` tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be. + +`twitter` - set this to `true` if you want a Twitter social button to appear at the bottom of your blog posts. + +`useEnglishUrl` - If you do not have [translations](guides-translation.md) enabled (e.g., by having a `languages.js` file), but still want a link of the form `/docs/en/doc.html` (with the `en`), set this to `true`. + +`users` - The `users` array mentioned earlier. + +`wrapPagesHTML` - boolean flag to indicate whether `html` files in `/pages` should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being `html` fragments instead of complete pages. It inserts the contents of your `html` file with no extra processing. Defaults to `false`. + +Users can also add their own custom fields if they wish to provide some data across different files. + +## Example siteConfig.js with all fields + +``` +const users = [ + { + caption: "User1", + image: "/test-site/img/docusaurus.svg", + infoLink: "https://www.example.com", + pinned: true + } +]; + +const siteConfig = { + title: "Docusaurus", + tagline: "Generate websites!", + url: "https://docusaurus.io", + baseUrl: "/", +// For github.io type URLS, you would combine the url and baseUrl like: +// url: "https://reasonml.github.io", +// baseUrl: "/reason-react/", + organizationName: "facebook", + projectName: "docusaurus", + noIndex: false, +// For no header links in the top nav bar -> headerLinks: [], + headerLinks: [ + { doc: "doc1", label: "Docs" }, + { page: "help", label: "Help" }, + { search: true }, + { blog: true } + ], + headerIcon: "img/docusaurus.svg", + favicon: "img/favicon.png", + colors: { + primaryColor: "#2E8555", + secondaryColor: "#205C3B" + }, + editUrl: "https://github.com/facebook/docusaurus/edit/master/docs/", +// users variable set above + users, + disableHeaderTitle: true, + disableTitleTagline: true, + separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"], + footerIcon: "img/docusaurus.svg", + translationRecruitingLink: + "https://crowdin.com/project/docusaurus", + algolia: { + apiKey: + "0f9f28b9ab9efae89810921a351753b5", + indexName: "github" + }, + gaTrackingId: "U-A2352", + highlight: { + theme: 'default' + }, + markdownPlugins: [ + function foo(md) { + md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) { + return '
bar
'; + } + } + ], + scripts: [ "https://docusaurus.io/slash.js" ], + stylesheets: [ "https://docusaurus.io/style.css" ], + facebookAppId: "1615782811974223", + facebookPixelId: "352490515235776", + twitter: "true" +}; + +module.exports = siteConfig; +``` diff --git a/website/versioned_docs/version-1.0.11/getting-started-installation.md b/website/versioned_docs/version-1.0.11/getting-started-installation.md new file mode 100644 index 0000000000..a441628a34 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/getting-started-installation.md @@ -0,0 +1,55 @@ +--- +id: version-1.0.11-installation +title: Installation +original_id: installation +--- + +Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you: + +1. Ensure you have the latest version of [Node](https://nodejs.org/en/download/) installed. We also recommend you install [Yarn](https://yarnpkg.com/en/docs/install) as well. + + > While we recommend Node 8.x or greater, your Node version must at least 6.x. + +1. Go into the root of your GitHub repo directory where you will be creating the docs. +1. `yarn global add docusaurus-init` or `npm install --global docusaurus-init` +1. `docusaurus-init` + +> After docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the `website` directory and typing `npm list docusaurus`. You can update to the [latest version](https://www.npmjs.com/package/docusaurus) of Docusaurus by typing `npm update`. + +Along with previously existing files and directories, your root directory will now contain a structure similar to: + +```bash +root-of-repo +├── docs-examples-from-docusaurus +│ └── doc1.md +│ └── doc2.md +│ └── doc3.md +│ └── exampledoc4.md +│ └── exampledoc5.md +└── website +│ └── blog-examples-from-docusaurus +│ └── 2016-03-11-blog-post.md +│ └── 2017-04-10-blog-post-two.md +│ └── core +│ └── Footer.js +│ └── node_modules +│ └── package.json +│ └── pages +│ └── sidebars.json +│ └── siteConfig.js +│ └── static +``` + +> If you do not want to install the init script globally, you can install it locally and then run it via `npx docusaurus-init` or from the `node_modules` directory that is created via `./node_modules/.bin/docusaurus-init`. You may want to remove the created `package.json` file and `node_modules` directory after you run the script. + +## Verifying Installation + +Running the Docusaurus initialization script, `docusaurus-init`, produces a runnable, example website to base your site upon. + +1. In your root, rename `docs-examples-from-docusaurus` to `docs`. +1. `cd website` +1. Rename `blog-examples-from-docusaurus` to `blog`. +1. Run the local webserver via `yarn start` or `npm start`. +1. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. + +![](/img/getting-started-preparation-verify.png) diff --git a/website/versioned_docs/version-1.0.11/getting-started-preparation.md b/website/versioned_docs/version-1.0.11/getting-started-preparation.md new file mode 100644 index 0000000000..c7fdb4f659 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/getting-started-preparation.md @@ -0,0 +1,46 @@ +--- +id: version-1.0.11-site-preparation +title: Site Preparation +original_id: site-preparation +--- + +After [installing Docusaurus](getting-started-installation.md), you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site. + +## Directory Structure + +As shown after you [installed Docusaurus](getting-started-installation.md), the initialization script created a directory structure similar to: + +```bash +root-of-repo +├── docs-examples-from-docusaurus +│ └── doc1.md +│ └── doc2.md +│ └── doc3.md +│ └── exampledoc4.md +│ └── exampledoc5.md +└── website +│ └── blog-examples-from-docusaurus +│ └── 2016-03-11-blog-post.md +│ └── 2017-04-10-blog-post-two.md +│ └── core +│ └── Footer.js +│ └── node_modules +│ └── package.json +│ └── pages +│ └── sidebars.json +│ └── siteConfig.js +│ └── static +``` + +> You may have already renamed the example blog (website/blog-examples-from-docusaurus and document (docs-examples-from-docusaurus) directories when you [verified the installation](getting-started-installation.md##verifying-installation). + +- The `website/core/Footer.js` file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user. +- The `website/blog-examples-from-docusaurus` folder contains examples of blog posts written in markdown. +- The `docs-examples-from-docusaurus` folder contains example documentation files written in markdown. +- The `website/pages` folder contains example top-level pages for the site. +- The `website/static` folder contains static assets used by the example site. +- The `website/siteConfig.js` file is the main configuration file used by Docusaurus. + +You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` files, but may edit them as you wish. + +You should keep the `website/pages` and `website/static` folders, but may change the content inside them as you wish. At the bare minimum you should have an `en/index.js` or `en/index.html` file inside `website/pages` and an image to use as your header icon inside `website/static`. \ No newline at end of file diff --git a/website/versioned_docs/version-1.0.11/getting-started-publishing.md b/website/versioned_docs/version-1.0.11/getting-started-publishing.md new file mode 100644 index 0000000000..51b2752c06 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/getting-started-publishing.md @@ -0,0 +1,153 @@ +--- +id: version-1.0.11-publishing +title: Publishing your site +original_id: publishing +--- + +You should now have a [site up and running locally](getting-started-site-creation.md). Once you have [customized](api-site-config.md) it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution. + +## Building Static HTML Pages + +To create a static build of your website, run the following script from the `website` directory: + +``` +yarn run build # or `npm run build` +``` + +This will generate a `build` folder inside the `website` directory containing the `.html` files from all of your docs and other pages included in `pages`. + +## Hosting Static HTML Pages + +At this point, you can grab all of the files inside the `website/build` folder and copy them over to your favorite web server's "html" directory. + +> For example, both Apache and nginx serve content from `/var/www/html` by default. That said, choosing a web server or provider is outside the scope of Docusaurus. + +### Using GitHub Pages + +While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: [GitHub Pages](https://pages.github.com/). + +Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public. + +> Even if your repo is private, anything published to a `gh-pages` branch will be [public](https://help.github.com/articles/user-organization-and-project-pages/). + +Most of the work to publish to GitHub pages is done for you automatically through the [`publish-gh-pages`](./api-commands.md#docusaurus-publish) script. You just need to determine the values for a few parameters required by the script. + +Two of the required parameters are set in the [`siteConfig.js`](api-site-config.md): + +- `organizationName`: The GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization. +- `projectName`: The name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus". + +> Docusaurus also supports deploying [user or organization sites](https://help.github.com/articles/user-organization-and-project-pages/#user--organization-pages). These sites will be served from the `master` branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it `source`). To do this, just set `projectName` to "_username_.github.io" (where _username_ is your username or organization name on GitHub) and `organizationName` to "_username_". The publish script will automatically deploy your site to the root of the `master` branch to be served. + +> While we recommend setting the `projectName` and `organizationName` in `siteConfig.js`, you can also use environment variables `ORGANIZATION_NAME` and `PROJECT_NAME`. + +One of the required parameters is set as a environment variable: + +- `GIT_USER`: The username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. + +There are also two optional parameters that are set as environment variables: + +- `USE_SSH`: If this is set to `true`, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set. + +- `CURRENT_BRANCH`: The branch that contains the latest docs changes that will be deployed. Usually, the branch will be `master`, but it could be any branch (default or otherwise) except for `gh-pages`. If nothing is set for this variable, then the current branch will be used. + +Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders: + +To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. + +```bash +GIT_USER= \ + CURRENT_BRANCH=master \ + USE_SSH=true \ + yarn run publish-gh-pages # or `npm run publish-gh-pages` +``` + +> The specified `GIT_USER` must have push access to the repository specified in the combination of `organizationName` and `projectName`. + +You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://_username_.github.io/_projectName_, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the `gh-pages` branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the [GitHub Pages documentation](https://pages.github.com) to learn more about how this hosting solution works. + +You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes. + +However, you can automate the publishing process with continuous integration (CI). + +## Automating Deployments Using Continuous Integration + +Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the `publish-gh-pages` script whenever your docs get updated. In the following section we'll be covering how to do just that using [Circle CI](https://circleci.com/), a popular continuous integration service provider. + +### Using Circle CI 2.0 + +If you haven't done so already, you can [setup CircleCI](https://circleci.com/signup/) for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the `publish-gh-pages` script as part of the deployment step. You can follow the steps below to get that setup. + +1. Ensure the GitHub account that will be set as the `GIT_USER` has `write` access to the repo that contains the documentation, by checking `Settings | Collaborators & teams` in the repo. +1. Log into GitHub as the `GIT_USER`. +1. Go to https://github.com/settings/tokens for the `GIT_USER` and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/), granting it full control of private repositories through the `repo` access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password. +1. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo. +1. Create a new environment variable named `GITHUB_TOKEN`, using your newly generated access token as the value. +1. Create a `.circleci` folder and create a `config.yml` under that folder. +1. Copy the text below into `.circleci/config.yml`. + +```yml +# If you only one circle to run on direct commits to master, you can uncomment this out +# and uncomment the filters: *filter-only-master down below too +# +# aliases: +# - &filter-only-master +# branches: +# only: +# - master + +version: 2 +jobs: + deploy-website: + docker: + # specify the version you desire here + - image: circleci/node:7.10 + + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | + git config --global user.email "@users.noreply.github.com" + git config --global user.name "" + echo "machine github.com login password $GITHUB_TOKEN" > ~/.netrc + cd website && yarn install && GIT_USER= yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: +# filters: *filter-only-master +``` + +Make sure to replace all `<....>` in the `command:` sequence with appropriate values. For ``, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times `` and `` will be the same. + +**DO NOT** place the actual value of `$GITHUB_TOKEN` in `circle.yml`. We already configured that as an environment variable back in Step 3. + +> If you want to use SSH for your GitHub repo connection, you can set `USE_SSH=true`. So the above command would look something like: `cd website && npm install && GIT_USER= USE_SSH=true npm run publish-gh-pages`. + +> Unlike when you run the `publish-gh-pages` script manually, when the script runs within the Circle environment, the value of `CURRENT_BRANCH` is already defined as an [environment variable within CircleCI](https://circleci.com/docs/1.0/environment-variables/) and will be picked up by the script automatically. + +Now, whenever a new commit lands in `master`, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the `publish-gh-pages` script. + +> If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI [instructions](https://circleci.com/docs/1.0/adding-read-write-deployment-key/) for adding a read/write deploy key. + +### Tips & Tricks + +When initially deploying to a `gh-pages` branch using Circle CI, you may notice that some jobs triggered by commits to the `gh-pages` branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic Circle CI config with the following contents: + +```yml +# Circle CI 2.0 Config File +# This config file will prevent tests from being run on the gh-pages branch. +version: 2 +jobs: + build: + machine: true + branches: + ignore: gh-pages + steps: + -run: echo "Skipping tests on gh-pages branch" +``` + +Save this file as `config.yml` and place it in a `.circleci` folder inside your `website/assets` folder. diff --git a/website/versioned_docs/version-1.0.11/getting-started-site-creation.md b/website/versioned_docs/version-1.0.11/getting-started-site-creation.md new file mode 100644 index 0000000000..40512845d6 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/getting-started-site-creation.md @@ -0,0 +1,64 @@ +--- +id: version-1.0.11-site-creation +title: Creating your site +original_id: site-creation +--- + +Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project. + +After [installation](getting-started-installation.md) and [preparation](getting-started-preparation.md), much of the work to create a basic site for your docs is already complete. + +## Site Structure + +Your site structure looks like the following: + +```bash +root-of-repo +├── docs +└── website +│ └── blog +│ └── core +│ └── Footer.js +│ └── node_modules +│ └── package.json +│ └── pages +│ └── sidebars.json +│ └── siteConfig.js +│ └── static +``` + +> This assumes that you removed the example `.md` files that were installed with the [initialization](getting-started-installation.md) script. + +All of your documentation files should be placed inside the `docs` folder as markdown `.md` files. Any blog posts should be inside the `blog` folder. + +> The blog posts must be formatted as `YYYY-MM-DD-your-file-name.md` + +## Create Your Basic Site + +To create a fully functional site, you only need to do a few steps: + +1. Add your documentation to the `/docs` folder as `.md` files, ensuring you have the proper [header](api-doc-markdown.md#documents) in each file. The simplest header would be the following, where `id` is the link name (e.g., `docs/intro.html`) and the `title`, is, of course, the title of the browser page. + + ``` + --- + id: intro + title: Getting Started + --- + + My *new content* here.. + ``` + +1. Add zero or more docs to the [`sidebars.json`](guides-navigation.md#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be. + + > If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL. + +3. Modify the `website/siteConfig.js` file to [configure your site](api-site-config.md), following the comments included in the [docs](api-site-config.md) and the `website/siteConfig.js` to guide you. +1. Create any [custom pages](guides-custom-pages.md#customizing-your-site-footer) and/or [customize](guides-custom-pages.md#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site. +1. Place assets, such as images, in the `website/static/` folder. +1. Run the site to see the results of your changes. + + ``` + cd website + yarn run start # or `npm run start` + # navigate to http://localhost:3000 + ``` diff --git a/website/versioned_docs/version-1.0.11/guides-blog.md b/website/versioned_docs/version-1.0.11/guides-blog.md new file mode 100644 index 0000000000..5d94127552 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/guides-blog.md @@ -0,0 +1,93 @@ +--- +id: version-1.0.11-blog +title: Adding a Blog +original_id: blog +--- + +## Initial Setup + +To setup your site's blog, start by creating a `blog` folder within your repo's `website` directory. + +Then, add a header link to your blog within `siteConfig.js`: + +``` +headerLinks: [ + ... + {blog: true, label: 'Blog'}, + ... +] +``` + + +## Adding Posts + +To publish in the blog, create a file within the blog folder with a formatted name of `YYYY-MM-DD-My-Blog-Post-Title.md`. The post date is extracted from the file name. + +For example, at `website/blog/2017-08-18-Introducing-Docusaurus.md`: + +``` +--- +author: Frank Li +authorURL: https://twitter.com/foobarbaz +authorFBID: 503283835 +title: Introducing Docusaurus +--- + +Lorem Ipusm.. +``` + + +## Header Options + +The only required field is `title`; however, we provide options to add author information to your blog post as well. + +- `author` - The text label of the author byline. +- `authorURL` - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc. +- `authorFBID` - The Facebook ID that is used to extract the profile picture. +- `title` - The blog post title. + + +## Summary Truncation + +Use the `` marker in your blog post to represent what will be shown as the summary when viewing all blog published blog posts. Anything above `` will be part of the summary. For example: + +``` +--- +title: Truncation Example +--- + +All this will be part of the blog post summary. + +Even this. + + + +But anything from here on down will not be. + +Not this. + +Or this. +``` + +## Changing How Many Blog Posts Show on Sidebar + +By default, 5 recent blog posts are shown on the sidebar. + +You can configure a specific amount of blog posts to show by adding a `blogSidebarCount` setting to your `siteConfig.js`. + +The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'. + +Example: +``` +blogSidebarCount: 'ALL' +``` + +## RSS Feed + +Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML tag. + +A summary of the post's text is provided in the RSS feed up to the ``. If no `` tag is found, then all text up 250 characters are used. + +## Social Buttons + +If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the `facebookAppId` and/or `twitter` [site configuration](api-site-config.md) options in `siteConfig.js`. diff --git a/website/versioned_docs/version-1.0.11/guides-custom-pages.md b/website/versioned_docs/version-1.0.11/guides-custom-pages.md new file mode 100644 index 0000000000..8baed4f387 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/guides-custom-pages.md @@ -0,0 +1,71 @@ +--- +id: version-1.0.11-custom-pages +title: Custom Pages +original_id: custom-pages +--- + +You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding `.js` files to the `website/pages` directory. These files are [React](https://reactjs.org/) components and the `render()` is called to create them, backed by CSS classes, etc. + +## Customizing Your Home Page + +The easiest way to get started customizing your home page is to use the example site that was [created](getting-started-site-creation.md) when you ran the [Docusaurus initialization script](getting-started-installation.md). + +You can [start](getting-started-preparation.md#verifying-installation) your local server and go to `http://localhost:3000` to see what the example home page looks like. From there, edit the `website/pages/en/index.js` file and its various components to use the images and text you want for your project. + +## Adding Other Custom Pages + +Docusaurus provides some simple example pages in the `website/pages/en` directory, including `index.js`, `users.js`, and `help.js`. These are good examples to showcase how to create a custom page for Docusaurus. + +```bash +root-of-repo +├── docs +└── website +│ └── blog +│ └── core +│ └── Footer.js +│ └── node_modules +│ └── package.json +│ └── pages +│ └── index.js +│ └── users.js +│ └── help.js +│ └── sidebars.json +│ └── siteConfig.js +│ └── static +``` + +Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. More information on how to use the provided components or include your own can be found [here](api-pages.md). Information on how to link to your different pages in the header navigation bar can be found [here](guides-navigation.md). + +> If you want your page to show up in your navigation header, you will need to update `siteConfig.js` to add to the `headerLinks` element. e.g., `{ page: "about-slash", label: "About/"}`, + +## Adding Static Pages + +Static `.html` files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the `static` folder in the same way as other [static assets](api-pages.md#using-static-assets). Alternatively, they can be placed in the `pages` folder and would be served as-is instead of being rendered from React. + +If you wish to use Docusaurus's stylesheet, you can access it at `${baseUrl}css/main.css`. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus's styles by adding them into the `siteConfig.separateCss` field in `siteConfig.js`. + +> You can set the [`$wrapPagesHTML` site config option](api-site-config.md#optional-fields) in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer. + +## Customizing Your Site Footer + +Starting from the example `core/Footer.js` file that was [created](getting-started-site-creation.md) when you ran the [Docusaurus initialization script](getting-started-installation.md), edit the footer to include any links to pages on your site or other sites that you wish to have. + +The example provided has three columns with a footer image on the left and Facebook's open source logo and copyright at the bottom. If your project is not a Facebook open source project, remove the logo and copyright. Otherwise, feel free to get creative with your footer and make it look however you'd like! + +Some suggestions for links you may want to provide: documentation, API, Twitter, Discord, Facebook groups, Stack Overflow, GitHub, etc. + +Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include. + +If you do not want a footer for your site, change the `render` function of `core/Footer.js` to return `null`. e.g., + +```jsx +const React = require("react"); + +class Footer extends React.Component { + render() { + return null; + } +} + +module.exports = Footer; +``` diff --git a/website/versioned_docs/version-1.0.11/guides-navigation.md b/website/versioned_docs/version-1.0.11/guides-navigation.md new file mode 100644 index 0000000000..125eae2939 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/guides-navigation.md @@ -0,0 +1,184 @@ +--- +id: version-1.0.11-navigation +title: Navigation and Sidebars +original_id: navigation +--- + +## Referencing Site Documents + +If you want to reference another document in your `docs` folder (or the location you set via the [optional `customDocsPath`](https://docusaurus.io/docs/en/site-config.html#optional-fields) path site configuration option), then you just use the name of the document you want to reference. + +For example, if you are in `doc2.md` and you want to reference `doc1.md`: + +``` +I am referencing a [document](doc1.md). +``` + +> Docusaurus currently does not support documents in nested folders; only in a flatfile structure. We are looking into adding support for nested folders. + +## How Documents are Linked + +New markdown files within `docs` will show up as pages on the website. Links to those documents are created first by using the `id` in the header of each document. If there is no `id` field, then the name of the file will serve as the link name. + +For example, creating an empty file such as `docs/getting-started.md` will enable the new page URL as `/docs/getting-started.html`. + +Suppose you add this to your document: + +``` +--- +id: intro +title: Getting Started +--- + +My *new content* here.. +``` + +If you set the `id` field in the markdown header of the file, the doc will then be accessed from a URL of the form `/docs/intro.html`. + +> You need an `id` field to be able to add the document to the sidebar. + +## Adding Documents to a Sidebar + +Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the `docs` sidebar. + +> "docs" is just a name. It has no inherit meaning. You can change it as you wish. + +You configure the contents of the sidebar, and the order of its documents, in the `website/sidebars.json` file. + +> Until you add your document to `website/sidebars.json`, they will only be accessible via a direct URL. The doc will not show up in any sidebar. + +Within `sidebars.json`, add the `id` you used in the document header to existing sidebar/category. In the below case, `docs` is the name of the sidebar and `Getting Started` is a category within the sidebar. + +``` +{ + "docs": { + "Getting Started": [ + "getting-started" +``` + +Or you can create a new category within the sidebar: + +``` +{ + "docs": { + ... + "My New Sidebar Category": [ + "getting-started" + ], + ... +``` + +### Adding New Sidebars + +You can also put a document in a new sidebar. In the following example, we are creating an `examples-sidebar` sidebar within `sidebars.json` that has a category called `My Example Category` containing a document with an `id` of `my-examples`. + +``` +{ + "examples-sidebar": { + "My Example Category": [ + "my-examples" + ], + }, + ... +``` + +It is important to note that until you [add a document from the `"examples-sidebar"` sidebar to the nav bar](#additions-to-the-site-navigation-bar), it will be hidden. + +## Additions to the Site Navigation Bar + +To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links. + +### Adding Documents + +After creating a new sidebar for the site by [adding](#adding-new-sidebars) it to `sidebars.json`, you can expose the new sidebar from the top navigation bar by editing the `headerLinks` field of `siteConfig.js`. + +``` +headerLinks: [ + ... + { doc: 'my-examples', label: 'Examples' }, + ... +], +``` + +A label called `Examples` will be added to the site navigation bar and when you click on it at the top of your site, the `examples-sidebar` will be shown and the default document will be `my-examples`. + +### Adding Custom Pages + +To add custom pages to the site navigation bar, entries can be added to the `headerLinks` of `siteConfig.js`. For example, if we have a page within `website/pages/help.js`, we can link to it by adding the following: + +``` +headerLinks: [ + ... + { page: 'help', label: 'Help' }, + ... +], +``` + +A label called `Help` will be added to the site navigation bar and when you click on it at the top of your site, the content from the `help.js` page will be shown. + +### Adding External Links + +Custom links can be added to the site navigation bar with the following entry in `siteConfig.js`: + +``` +headerLinks: [ + ... + { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' }, + ... +], +``` + +A label called `GitHub` will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown. + +> To open external links in a new tab, provide an `external: true` flag within the header link config. + +## Site Navigation Bar Positioning + +You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website. + +### Search + +If search is enabled on your site, your search bar will appear to the right of your links. If you want to put the search bar between links in the header, add a search entry in the `headerLinks` config array: + +``` +headerLinks: [ + { doc: 'foo', label: 'Foo' }, + { search: true }, + { doc: 'bar', label: 'Bar' }, +], +``` + +### Languages Dropdown + +If translations is enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). If you want to put the language selection drop down between links in the header, add a languages entry in the `headerLinks` config array: + +``` +headerLinks: [ + { doc: 'foo', label: 'Foo' }, + { languages: true }, + { doc: 'bar', label: 'Bar' }, +], +``` + +## Active Links In Site Navigation Bar + +The links in the top navigation bar get `siteNavItemActive` and `siteNavGroupActive` class names to allow you to style the currently active link different from the others. `siteNavItemActive` is applied when there's an exact match between the navigation link and the currently displayed web page. + +> This does not include links of type `href` which are meant for external links only. If you manually set an `href` in your `headerLinks` to an internal page, document, or blog post, it will not get the `siteNavItemActive` class even if that page is being displayed. + +The `siteNavGroupActive` class will be added to these links: + +* `doc` links that belong to the same sidebar as the currently displayed document +* The blog link when a blog post, or the blog listing page is being displayed + +These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule. + +## Secondary On-Page Navigation + +We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the `onPageNav` site configuration [option](api-site-config.md#optional-fields) to your `siteConfig.js`. + +``` +onPageNav: 'separate', +``` + +Currently, `separate` is the only option available for this field. This provides a separate navigation on the right side of the page. diff --git a/website/versioned_docs/version-1.0.11/guides-search.md b/website/versioned_docs/version-1.0.11/guides-search.md new file mode 100644 index 0000000000..bdeba1b9f9 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/guides-search.md @@ -0,0 +1,65 @@ +--- +id: version-1.0.11-search +title: Enabling Search +original_id: search +--- + +Docusaurus supports search using [Algolia DocSearch](https://community.algolia.com/docsearch/). Once you have set up your site, [enter your site information](https://community.algolia.com/docsearch/) to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site. + +## Enabling the Search Bar + +Enter your search-only API key and index name into `siteConfig.js` in the `algolia` section to enable search for your site. + +```js +const siteConfig = { + ... + algolia: { + apiKey: "my-search-only-api-key-1234", + indexName: "my-index-name" + }, + ... +} +``` + +## Extra Search Options + +You can also specify extra [search options used by Algolia](https://community.algolia.com/docsearch/documentation/) by using an `algoliaOptions` field in `algolia`. This may be useful if you want to provide different search results for the different versions or languages of your docs. Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be [found here](https://www.algolia.com/doc/api-reference/api-parameters/#overview). + +```js +const siteConfig = { + ... + algolia: { + ... + algoliaOptions: { + facetFilters: [ "tags:VERSION" ], + hitsPerPage: 5 + } + }, +} +``` + +## Controlling the Location of the Search Bar + +By default, the search bar will be the rightmost element in the top navigation bar. + +If you want to change the default location, add the `searchBar` flag in the `headerLinks` field of `siteConfig.js` in your desired location. For example, you may want the search bar in between your internal and external links. + +```js +const siteConfig = { + ... + headerLinks: [ + {...} + {...} + { search: true } + {...} + {...} + ], + ... +} +``` + +## Disabling the Search Bar + +To disable the search bar, comment out (recommended) or delete the `algolia` section in the `siteConfig.js` file. + +Also, if you have customized the location of the search bar in `headerLinks`, set `search: false`. diff --git a/website/versioned_docs/version-1.0.11/guides-translation.md b/website/versioned_docs/version-1.0.11/guides-translation.md new file mode 100644 index 0000000000..43b4c6f9fd --- /dev/null +++ b/website/versioned_docs/version-1.0.11/guides-translation.md @@ -0,0 +1,246 @@ +--- +id: version-1.0.11-translation +title: Translations & Localization +original_id: translation +--- + +Docusaurus allows for easy translation functionality using [Crowdin](https://crowdin.com/). Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a `` tag. Other titles and labels will also be found and properly translated. + +## Docusaurus Translation Configurations + +To generate example files for translations with Docusaurus, run the `examples` script with the command line argument `translations`: + +``` +npm run examples translations +``` + +or + +``` +yarn examples translations +``` + +This will create the following files: + +``` +pages/en/help-with-translations.js +languages.js +../crowdin.yaml +``` + +- The `pages/en/help-with-translations.js` file includes the same starter help page generated by the `examples` script, but now includes translation tags. + +> Generally, you will use `help-with-translations.js` as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to `help.js` and use it as a starting point. + +- The `languages.js` file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled. + +- The `crowdin.yaml` file is used to configure Crowdin integration, and is copied up one level into your Docusaurus project repo. If your Docusaurus project resides in `/project/website`, then `crowdin.yaml` will be copied to `/project/crowdin.yaml`. + +## Translating Your Existing Docs + +Your documentation files (e.g., the `.md` files that live in your `docs` directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly. + + +## Enabling Translations on Pages + +Pages allow you to customize layout and specific content of pages like a custom index page or help page. + +Pages with text that you want translated should be placed in `website/pages/en` folder. + +Wrap strings you want translated in a `` tag, and add the following `require` statement to the top of the file: + +```jsx +... +const translate = require("../../server/translate.js").translate; +... +

+ This header will be translated +

+... +``` + +You can also include an optional description attribute to give more context to a translator about how to translate the string: + +```jsx +

+ Rose +

+``` + +> The `` tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use [translations](${siteConfig.baseUrl}docs/${this.props.language}/translation.html)", wrapping the `` tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of `` tags amongst the pure substrings of that string. + +## Gathering Strings to Translate + +The strings within localized Pages must be extracted and provided to Crowdin. + +Add the following script to your `website/package.json` file, if it does not exist already: + +```json +... +"scripts": { + "write-translations": "docusaurus-write-translations" +}, +... +``` + +Running the script will generate a `website/i18n/en.json` file containing all the strings that will be translated from English into other languages. + +The script will include text from the following places: + +- `title` and `sidebar_label` strings in document markdown headers +- category names in `sidebars.json` +- tagline in `siteConfig.js` +- header link `label` strings in `siteConfig.js` +- strings wrapped in the `` tag in any `.js` files inside `pages` + +## How Strings Get Translated + +Docusaurus itself does not do any translation from one language to another. Instead, it integrates [Crowdin](https://crowdin.com/) to upload translations and then downloads the appropriately translated files from Crowdin. + +## How Docusaurus Uses String Translations + +This section provides context about how translations in Docusaurus works. + +### Strings + +A Docusaurus site has many strings used throughout it that require localization. However, maintaining a list of strings used through out a site can be laborious. Docusaurus simplifies this by centralizing strings. + +The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into `i18n/en.json`. When your files are translated, say into Spanish, a `i18n/es-ES.json` file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda'). + +### Markdown Files + +For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template. + +### Other Pages + +For other pages, Docusaurus will automatically transform all `` tags it finds into function calls that return the translated strings from the corresponding localized file _`locale.json`_. + +## Crowdin + +Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations. + +Create your translation project on [Crowdin](https://crowdin.com/). You can use [Crowdin's guides](https://support.crowdin.com/translation-process-overview/) to learn more about the translations work flow. _We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of `en-US` localization files as this can lead to confusion._ + +> Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to ["Hide - all duplicates will share the same translation"](https://support.crowdin.com/api/create-project/). This setting will ensure that identical strings between versions share a single translation. + +Your project will need a `crowdin.yaml` file generated. If you ran `yarn examples translations` or `npm run examples translations`, this file was created for you on the same level as your `website` directory. + +> You will need to install the `crowdin` command line interface. Please follow the [installation directions](https://support.crowdin.com/cli-tool/). + +The example below can be automatically generated by the Docusaurus cli with the `examples` script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded. + +Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional. + +```yaml +project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID +api_key_env: CROWDIN_DOCUSAURUS_API_KEY +base_path: "./" +preserve_hierarchy: true + +files: + - + source: '/docs/*.md' + translation: '/website/translated_docs/%locale%/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW' +``` + +You can go [here](https://support.crowdin.com/configuration-file/) to learn more about customizing your `crowdin.yaml` file. + +### Setup the Crowdin Scripts + +You will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in `/docs` as well as translatable strings in `website/i18n/en.json`. (These strings can be generated by running `yarn write-translations`.) + +You can add the following to your `package.json` to manually trigger Crowdin. + +```json +"scripts": { + "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master", + "crowdin-download": "crowdin --config ../crowdin.yaml download -b master" +}, +``` + +### Manual File Sync + +You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order: + +``` +CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload +CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download +``` + +> `YOUR_CROWDIN_PROJECT_ID` is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to `docusaurus`. `YOUR_CROWDIN_API_KEY` is a unique key that is like a password. You can find it in the `API` tab of your Crowdin project's `Settings`. + +> These commands require having an environment variable set with your Crowdin project id and api key (`CROWDIN_PROJECT_ID`, `CROWDIN_API_KEY`). You can preface them inline as done above or add them permanently to your `.bashrc` or `.bash_profile`. + +> If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (`CROWDIN_PROJECTNAME_PROJECT_ID`, `CROWDIN_PROJECTNAME_API_KEY`). + +> Since the files are generated, you do not need to have any files in your `website/i18n` or `website/translated_docs` directory as part of your repo. So you can can add `website/i18n/*` and `website/translated_docs` to your `.gitignore` file. + +### Automated File Sync Using CircleCI + +You can automate pulling down and uploading translations for your files using the [CircleCI](https://circleci.com) web continuous integration service. + +First, update the `circle.yml` file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example `circle.yml` file: + +```yaml +machine: + node: + version: 6.10.3 + npm: + version: 3.10.10 + +test: + override: + - "true" + +deployment: + website: + branch: master + commands: + # configure git user + - git config --global user.email "test-site-bot@users.noreply.github.com" + - git config --global user.name "Website Deployment Script" + - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc + # install Docusaurus and generate file of English strings + - cd website && npm install && npm run write-translations && cd .. + # crowdin install + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # translations upload/download + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + - cd website && GIT_USER=test-site-bot npm run publish-gh-pages +``` + +The `crowdin` command uses the `crowdin.yaml` file generated with the `examples` script. It should be placed in your project directory to configure how and what files are uploaded/downloaded. + +Note that in the `crowdin.yaml` file, `CROWDIN_PROJECT_ID` and `CROWDIN_API_KEY` are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings. + +Now, Circle will help you automatically get translations prior to building your website. The provided `crowdin.yaml` file will copy translated documents into `website/translated_docs/`, and translated versions of the `i18n/en.json` strings file will into `i18n/${language}.json`. + +If you wish to use Crowdin on your machine locally, you can install the [Crowdin CLI tool](https://support.crowdin.com/cli-tool/) and run the same commands found in the `circle.yaml` file. The only difference is that you must set `project_identifier` and `api_key` values in the `crowdin.yaml` file since you will not have Circle environment variables set up. + +## Versioned Translations + +If you wish to have translation and versioning for your documentation, add the following section to the end of your `crowdin.yaml` file: + +```yaml + - + source: '/website/versioned_docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: *anchor +``` + +Translated, versioned documents will be copied into `website/translated_docs/${language}/${version}/`. diff --git a/website/versioned_docs/version-1.0.11/guides-versioning.md b/website/versioned_docs/version-1.0.11/guides-versioning.md new file mode 100644 index 0000000000..6b27905041 --- /dev/null +++ b/website/versioned_docs/version-1.0.11/guides-versioning.md @@ -0,0 +1,87 @@ +--- +id: version-1.0.11-versioning +title: Versioning +original_id: versioning +--- + +You can use the `version` script to cut a new documentation version based on the latest content in the `docs` folder. That specific set of documentation will then be preserved and accessible even as the documentation in the `docs` folder changes moving forward. + +## How to Create New Versions + +Run the following script to generate a starter versions page listing all the site versions: + +```bash +yarn examples versions +``` + +This creates the `pages/en/versions.js` file. + +You can edit this file later on to customize how you display the versions. + +Add the following script to your `package.json` file if it doesn't already exist: + +```json +... +"scripts": { + "version": "docusaurus-version" +}, +... +``` + +Run the script with a command line argument of the version you wish to create. e.g., + +```bash +yarn run version 1.0.0 +``` + +This will preserve all documents currently in the `docs` folder and make them available as documentation for version `1.0.0`. + +If, for example, you ran the version script with `1.0.0` as the version number, version `1.0.0` is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier. + +Documents in the `docs` folder will be considered part of version `next` and they are available, for example, at the url `docs/next/doc1.html`. Documents from the latest version use the url `docs/doc1.html`. + +Running the script again with `yarn run version 2.0.0` will create a version `2.0.0`, making version `2.0.0` the most recent set of documentation. Documents from version `1.0.0` will use the url `docs/1.0.0/doc1.html` while `2.0.0` will use `docs/doc1.html`. + +## Versioning Patterns + +You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered. + +## Storing Files for Each Version + +Versioned documents are placed into `website/versioned_docs/version-${version}`, where `${version}` is the version number you supplied the `version` script. + +The markdown header for each versioned doc is altered by renaming the id front matter field to `original_id`, then using `"version-${version}-${original_id}"` as the value for the actual `id` field. + +Versioned sidebars are copied into `website/versioned_sidebars` and are named as `version-${version}-sidebars.json`. + +A `website/versions.json` file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the `versions.json` file. + +If you wish to change the documentation for a past version, you can access the files for that respective version. + +## Fallback Functionality + +Only files in the `docs` folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file. + +For example, a document with the original id `doc1` exists for the latest version, `1.0.0`, and has the same content as the document with the id `doc1` in the `docs` folder. When a new version `2.0.0` is created, the file for `doc1` will not be copied into `versioned_docs/version-2.0.0/`. There will still be a page for `docs/2.0.0/doc1.html`, but it will use the file from version `1.0.0`. + +## Renaming Existing Versions + +To rename an existing version number to something else, first make sure the following script is in your `package.json` file: + +```json +... +"scripts": { + "rename-version": "docusaurus-rename-version" +}, +... +``` + +Run the script with command line arguments of first, the current version name, then second, the new version name. e.g., + +```bash +yarn run rename-version 1.0.0 1.0.1 +``` + +## Versioning and Translations + +If you wish to use versioning and translations features, the `crowdin.yaml` file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder `translated_docs/${language}/version-${version}/`. For more information, check out the [translations guide](guides-translation.md). diff --git a/website/versioned_sidebars/version-1.0.11-sidebars.json b/website/versioned_sidebars/version-1.0.11-sidebars.json new file mode 100644 index 0000000000..3999dd35f3 --- /dev/null +++ b/website/versioned_sidebars/version-1.0.11-sidebars.json @@ -0,0 +1,24 @@ +{ + "version-1.0.11-docs": { + "Getting Started": [ + "version-1.0.11-installation", + "version-1.0.11-site-preparation", + "version-1.0.11-site-creation", + "version-1.0.11-publishing" + ], + "Guides": [ + "version-1.0.11-blog", + "version-1.0.11-custom-pages", + "version-1.0.11-search", + "version-1.0.11-navigation", + "version-1.0.11-translation", + "version-1.0.11-versioning" + ], + "API": [ + "version-1.0.11-commands", + "version-1.0.11-doc-markdown", + "version-1.0.11-api-pages", + "version-1.0.11-site-config" + ] + } +} diff --git a/website/versions.json b/website/versions.json new file mode 100644 index 0000000000..38546bd469 --- /dev/null +++ b/website/versions.json @@ -0,0 +1,3 @@ +[ + "1.0.11" +]