mirror of
https://github.com/facebook/docusaurus.git
synced 2025-04-30 02:37:59 +02:00
* Make it clear where the `docs` folder is It was not clear, to the beginner user—who this tutorial is for—where the `docs` folder was . The only reason I know this is because I'm a beginner user and I tried for too many minutes to find the `docs` folder inside the `website` folder. I had this assumption because the previous example is offered under the assumption that you're in the `website` folder. Feel free to change the wording, I just want to make it clear where you should be looking, if you're new. * Update tutorial-create-pages.md
2.8 KiB
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.
Creating a Regular Page
- Go into the
pages/en
directory and create a 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;
- 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!". 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 expressability 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 calleddoc4.md
. Thedocs
folder is in the root of your Docusaurus project, one level abovewebsite
. - 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
- Go to
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"]
}
}
- Kill your webserver (Cmd + C or Ctrl + C) and restart it (with
npm run start
) because a server restart is needed for sidebar changes. - 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.