website
This website was created with Docusaurus.
What's In This Document
Get Started in 5 Minutes
Make sure all the dependencies for the website are installed:
Run your dev server:
Directory Structure
Your project file structure should look something like this
Editing Content
Editing an existing docs page
Edit docs by navigating to docs/
and editing the corresponding document:
docs/doc-to-be-edited.md
For more information about docs, click here
Editing an existing blog post
Edit blog posts by navigating to website/blog
and editing the corresponding post:
website/blog/post-to-be-edited.md
For more information about blog posts, click here
Adding Content
Adding a new docs page to an existing sidebar
Create the doc as a new markdown file in
/docs
, exampledocs/newly-created-doc.md
:
Refer to that doc's ID in an existing sidebar in
website/sidebar.json
:
For more information about adding new docs, click here
Adding a new blog post
Make sure there is a header link to your blog in
website/siteConfig.js
:
website/siteConfig.js
Create the blog post with the format
YYYY-MM-DD-My-Blog-Post-Title.md
inwebsite/blog
:
website/blog/2018-05-21-New-Blog-Post.md
For more information about blog posts, click here
Adding items to your site's top navigation bar
Add links to docs, custom pages or external links by editing the headerLinks field of
website/siteConfig.js
:
website/siteConfig.js
For more information about the navigation bar, click here
Adding custom pages
Docusaurus uses React components to build pages. The components are saved as .js files in
website/pages/en
:If you want your page to show up in your navigation header, you will need to update
website/siteConfig.js
to add to theheaderLinks
element:
website/siteConfig.js
For more information about custom pages, click here.
Full Documentation
Full documentation can be found on the website.
Last updated