Skip to main content

Create a Document

Documents are groups of pages connected through:

  • a sidebar
  • previous/next navigation
  • versioning

Create your first Doc​

Create a Markdown file at docs/hello.md:

docs/hello.md
# Hello

This is my **first Docusaurus document**!
Reminder

The **(...)** stands for bold font, as we learned in Introduction to Markdown.

After committing and the update of the website, a new document is now available at https://<my_git_account>.github.io/docu-cicd-teach4/docs/hello.

Configure the Sidebar​

Docusaurus automatically creates a sidebar from the docs folder.

The sidebar of a page can be customized via metadata on the page itself. For example, to change its label and position, you can use:

docs/hello.md
---
sidebar_label: 'Hi!'
sidebar_position: 3
---

# Hello

This is my **first Docusaurus document**!

Is it in the expected place? Change if necessary.

It is also possible to create your sidebar explicitly in sidebars.ts (you can simply uncomment corresponding section in sidebars.ts file):

sidebars.ts
export default {
  tutorialSidebar: [
    'github',
    'fork_and_deploy',
    'md_intro',
    'docusaurus_intro',
    {
      type: 'category',
      label: 'Tutorial',
      items: ['tutorial-basics/create-a-document'],
    },
    'task',
    'hello',
  ],
};
Excercise

Which has precedence in Docusaurus: sidebars.ts or the position attribute in Markdown files?