diff options
author | Nikita Tchayka <nikitatchayka@gmail.com> | 2023-08-27 13:01:29 +0100 |
---|---|---|
committer | Nikita Tchayka <nikitatchayka@gmail.com> | 2023-08-27 13:01:29 +0100 |
commit | 659aeff39ded6bf6bd0dfc40ccc5ff07ffc10f51 (patch) | |
tree | eca686ecb16ff82a1fd1f731aa237841acdfb982 /docs/tutorial-basics/create-a-document.md | |
download | neohaskell.github.io-659aeff39ded6bf6bd0dfc40ccc5ff07ffc10f51.tar.gz neohaskell.github.io-659aeff39ded6bf6bd0dfc40ccc5ff07ffc10f51.tar.bz2 neohaskell.github.io-659aeff39ded6bf6bd0dfc40ccc5ff07ffc10f51.zip |
Update
Diffstat (limited to 'docs/tutorial-basics/create-a-document.md')
-rw-r--r-- | docs/tutorial-basics/create-a-document.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/tutorial-basics/create-a-document.md b/docs/tutorial-basics/create-a-document.md new file mode 100644 index 0000000..ffddfa8 --- /dev/null +++ b/docs/tutorial-basics/create-a-document.md @@ -0,0 +1,57 @@ +--- +sidebar_position: 2 +--- + +# 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`: + +```md title="docs/hello.md" +# Hello + +This is my **first Docusaurus document**! +``` + +A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). + +## Configure the Sidebar + +Docusaurus automatically **creates a sidebar** from the `docs` folder. + +Add metadata to customize the sidebar label and position: + +```md title="docs/hello.md" {1-4} +--- +sidebar_label: 'Hi!' +sidebar_position: 3 +--- + +# Hello + +This is my **first Docusaurus document**! +``` + +It is also possible to create your sidebar explicitly in `sidebars.js`: + +```js title="sidebars.js" +module.exports = { + tutorialSidebar: [ + 'intro', + // highlight-next-line + 'hello', + { + type: 'category', + label: 'Tutorial', + items: ['tutorial-basics/create-a-document'], + }, + ], +}; +``` |