--- id: getting-started title: Docusaurus layout: docs category: Docusaurus permalink: docs/en/doc1.html next: translation --- ## Getting Started ### Project Structure In your project repo, all of your documentation files should be placed inside a `docs` folder. Any blog posts should be inside a `blog` folder. Create a `website` folder inside which you will install and run docusaurus. ### Installation Inside of your `website` folder, create a `package.json` file with the following scripts for Docusaurus: ```json { "scripts": { "start": "docusaurus-start", "build": "docusaurus-build", "publish-gh-pages": "docusaurus-publish", "examples": "docusaurus-examples" } } ``` Install Docusaurus using `npm` or `yarn`: ``` npm install --save-dev docusaurus ``` or ``` yarn add docusaurus -dev ``` ## Configuration ### Generate Examples To create example files for configuration, run `examples` using `npm` or `yarn`: ``` npm run examples ``` or ``` yarn run examples ``` This will create the following files/folders in your website folder: ``` core/Footer.js example-blog/... example-docs/... pages/... static/img/... siteConfig.js ``` `examples` will not overwrite any existing files of the same name in your website folder. The provided example files contain configurations for an example site. The `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 `example-blog` folder contains examples of blog posts written in markdown. The `example-docs` folder contains example documentation files written in markdown. The `pages` folder contains example top-level pages for the site. The `static` folder contains static assets used by the example site. The `siteConfig.js` file is the main configuration file used by Docusaurus. ### How to Configure Your Site Configure the `siteConfig.js` file which has comments guiding you through what needs to be done and how each configuration affects your website. Customize `core/Footer.js` which will serve as the footer for each page on your website. Include your own top-level pages as React components in `pages`. - These components should just be the body sections of the pages you want, and they will be included with the header and footer that the rest of Docusaurus uses. - Currently, if you want to add other React components to your pages, you must include all of it inside that file due to how `require` paths are set-up. - You may also include `.html` files directly, but this is not recommended, and these will just be served as is and will not have any of the header/footer/styles shared by the rest of Docusaurus. All images and other static assets you wish to include should be placed inside the `static` folder. Any `.css` files provided in `static` will be concatenated to the standard styles provided by Docusaurus and used site-wide. ### Document and Blog Front Matters Documentation should contain front matter that follows this example: ``` --- id: doc1 title: Document Title layout: docs1 category: Sidebar Category 1 permalink: docs/en/doc1.html previous: doc0 next: doc2 --- ``` Blog posts should be written as markdown files with the following front matter: ``` --- title: Blog Post Title author: Author Name authorURL: http://twitter.com/author authorFBID: 21315325 --- ``` In the blog post you should include a line ``. This will determine under which point text will be ignored when generating the preview of your blog post. Blog posts should have the file name format: `yyyy-mm-dd-your-file-name.md`. ## Using Docusaurus ### Run the Server To run your website locally run the script: ``` npm run start ``` or ``` yarn run start ``` This will start a server hosting your website locally at `localhost:3000`. This server will ignore any occurences `siteConfig.baseUrl` in URLs, e.g. `localhost:3000/your-site/index.html` will be the same as `localhost:3000/index.html`. Any changes to configured files will be reflected by refreshing the page, i.e. the server does not need to be restarted to show changes. You may also specify a different port to start your server on as a command line argument, e.g. `npm run start 9000`. ### Build Static Pages To create a static build of your website, run the script: ``` npm run build ``` or ``` yarn run build ``` This will generate `.html` files from all of your docs and other pages included in `pages`. This allows you to check whether or not all your files are being generated correctly. The build folder is inside Docusaurus's directory inside `node_modules`. ### Publishing Your Website Use CircleCI to publish your website whenever your project repo is updated. Configure your circle.yml file in your project repo to run commands to publish to GitHub Pages. An example is shown here: ```yaml machine: node: version: 6.10.3 npm: version: 3.10.10 test: override: - "true" deployment: website: branch: master commands: - 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 - cd website && npm install && GIT_USER=test-site-bot npm run publish-gh-pages ``` Note that in this case a GitHub user `test-site-bot` is created to use just for publishing. Make sure to give your Git user push permissions for your project and to set a GITHUB_TOKEN environment variable in Circle if you choose to publish this way. If you wish to manually publish your website with the `publish-gh-pages` script, run the following example command with the appropriate variables for your project: ``` DEPLOY_USER=deltice GIT_USER=test-site-bot CIRCLE_PROJECT_USERNAME=deltice CIRCLE_PROJECT_REPONAME=test-site CIRCLE_BRANCH=master npm run publish-gh-pages ``` ## More Information For details on how to set up translation support, read [here](/docs/en/translation.md). For details on how to set up documentation search, read [here](/docs/en/search.md).