docusaurus/docs/tutorial-create-pages.md
Hongarc f18e07343c docs: fix typo for docs folder (#1484)
* docs: fix typo for `docs` folder

* docs: request change for #1484

* Update api-doc-markdown.md
2019-05-17 10:26:55 -07:00

2.8 KiB

id title
tutorial-create-pages Create Pages

In this section, we will learn about creating two new types of pages in Docusaurus, a regular page and a documentation page.

Docusaurus MacBook

Creating a Regular Page

  1. Go into the pages/en directory and create a file called hello-world.js with the following contents:
const React = require('react');

const CompLibrary = require('../../core/CompLibrary.js');

const Container = CompLibrary.Container;
const GridBlock = CompLibrary.GridBlock;

function HelloWorld(props) {
  return (
    <div className="docMainWrapper wrapper">
      <Container className="mainContainer documentContainer postContainer">
        <h1>Hello World!</h1>
        <p>This is my first page!</p>
      </Container>
    </div>
  );
}

module.exports = HelloWorld;
  1. Go to http://localhost:3000/hello-world and you should be able to see the new page.
  2. Change the text within the <p>...</p> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.
- <p>This is my first page!</p>
+ <p>I can write JSX here!</p>

React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages here.

Docusaurus React

Create a Documentation Page

  1. Create a new file in the docs folder called doc4.md. The docs folder is in the root of your Docusaurus project, one level above website.
  2. Paste the following contents:
---
id: doc4
title: This is Doc 4
---

I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).

## Markdown Syntax

**Bold** _italic_ `code` [Links](#url)

> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.

* Hey
* Ho
* Let's Go
  1. Go to website/sidebars.json and add "doc4" after "doc1". This ID should be the same one as in the Markdown file above.
{
  "docs": {
    "Docusaurus": [
      "doc1",
+     "doc4"
    ],
    "First Category": ["doc2"],
    "Second Category": ["doc3"]
  },
  "docs-other": {
    "First Category": ["doc4", "doc5"]
  }
}
  1. Kill your web server (Cmd + C or Ctrl + C) and restart it (with npm run start) because a server restart is needed for sidebar changes.
  2. Navigate to http://localhost:3000/docs/doc4.

You've created your first documentation page on Docusaurus! The sidebars.json is where you specify the order of your documentation pages and in the front matter of the Markdown file is where you provide metadata about that page.

Learn more about creating docs pages here.