Skip to content

Commit

Permalink
add documentation regarding usage of nested docs + git ignore .idea (#…
Browse files Browse the repository at this point in the history
…860)

* add documentation regarding usage of nested docs + add .idea in .gitignore

* Remove 1.3.3, move to navigation & simplify wording

* add documentation for docusaurus >= v1.2.0 a well
  • Loading branch information
steevehook authored and endiliey committed Jul 19, 2018
1 parent aa1f826 commit 22f3a85
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.DS_Store
.vscode
.idea
*.code-workspace

node_modules
Expand Down
22 changes: 22 additions & 0 deletions docs/guides-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,28 @@ Or you can create a new category within the sidebar:
}
```

However, for a document located in a docs subdirectory like below:

```bash
docs
└── dir1
└── getting-started.md
```

You should provide `directory/id` instead of `id` in `sidebars.json`.

```js
{
"docs": {
"My New Sidebar Category": [
"dir1/getting-started"
],
...
},
...
}
```

### Adding New Sidebars

You can also put a document in a new sidebar. In the following example, we are creating an `examples-sidebar` sidebar within `sidebars.json` that has a category called `My Example Category` containing a document with an `id` of `my-examples`.
Expand Down
22 changes: 22 additions & 0 deletions website/versioned_docs/version-1.2.0/guides-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,28 @@ Or you can create a new category within the sidebar:
}
```

However, for a document located in a docs subdirectory like below:

```bash
docs
└── dir1
└── getting-started.md
```

You should provide `directory/id` instead of `id` in `sidebars.json`.

```js
{
"docs": {
"My New Sidebar Category": [
"dir1/getting-started"
],
...
},
...
}
```

### Adding New Sidebars

You can also put a document in a new sidebar. In the following example, we are creating an `examples-sidebar` sidebar within `sidebars.json` that has a category called `My Example Category` containing a document with an `id` of `my-examples`.
Expand Down

0 comments on commit 22f3a85

Please sign in to comment.