mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-27 15:07:53 +02:00
refactor(init): share common files between templates (#5315)
* Create shared folder & update init logic Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Restore needed links Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Prevent copying symlinks Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Reuse some FB files Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Minor tweak Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Minor refactors Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Fix bootstrap url Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Add path alias Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Handle facebook template more gracefully Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * minor refactor: extract getTypeScriptBaseTemplate Co-authored-by: slorber <lorber.sebastien@gmail.com>
This commit is contained in:
parent
58a8b0ea2c
commit
4c246493ef
98 changed files with 72 additions and 1431 deletions
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
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`.
|
||||
|
||||
## Configure the Sidebar
|
||||
|
||||
Docusaurus automatically **creates a sidebar** from the `docs` folder.
|
||||
|
||||
Add metadatas 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`:
|
||||
|
||||
```diff title="sidebars.js"
|
||||
module.exports = {
|
||||
tutorialSidebar: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial',
|
||||
- items: [...],
|
||||
+ items: ['hello'],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue