Create Pages
In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.
Create a Regular Page
- In the
website/pages/en
directory of your repository, save a text file calledhello-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;
Use any text editor to make the file, such as Microsoft Visual Studio Code or Komodo Edit.
- Go to http://localhost:3000/hello-world and you should be able to see the new page.
- Change the text within the
<p>...</p>
to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.
- <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.
Create a Documentation Page
- Create a new file in the
docs
folder calleddoc9.md
. Thedocs
folder is in the root of your Docusaurus project, one level abovewebsite
. - Paste the following contents:
---
id: doc9
title: This is Doc 9
---
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
- The
sidebars.json
is where you specify the order of your documentation pages, so openwebsite/sidebars.json
and add"doc9"
after"doc1"
. This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file.
{
"docs": {
"Docusaurus": [
"doc1",
+ "doc9"
],
"First Category": ["doc2"],
"Second Category": ["doc3"]
},
"docs-other": {
"First Category": ["doc4", "doc5"]
}
}
- A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run
npm start
oryarn start
. - Navigate to http://localhost:3000/docs/doc9 to see the new documentation page.
You've created your first documentation page on Docusaurus!
Learn more about creating docs pages here.