Skip to content

Commit b47c16d

Browse files
committed
docs: Update example
1 parent 5fa7e08 commit b47c16d

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

docs/README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -195,23 +195,16 @@ You can choose to configure a custom sidebar. This is necessary to link to the m
195195
196196
##### Guidelines
197197
198-
Guidelines for setting up a sidebar file:
198+
How to setup a sidebar file:
199199
200200
- The format should be bullet points in markdown format.
201201
- Each menu item should be a markdown link e.g. `[Name](link)`. An item may exist on the menu without a link - this is useful for grouping items together under a menu heading.
202-
- The links must be follow restrictions noted above in [Doc links](#doc-links). If the doc files change (e.g. are renamed or moved), you need to remember to update the sidebar config.
202+
- The links must be follow restrictions noted above in [Linking to pages](#linking-to-pages). If the doc files change (e.g. are renamed or moved), you need to remember to update the sidebar config.
203203
- The bullet points may optionally be nested, using indentation. You may create arbitrary indentation in your sidebar, even if all you files are at the same level in the _docs_ directory.
204204
205205
Example:
206206
207-
```markdown
208-
- [Home](/#my-app)
209-
- [Foo](foo.md)
210-
- [Bar](bar.md)
211-
- Baz
212-
* [Fizz](baz/fizz.md)
213-
* [Foo Bar](baz/foobar.md)
214-
```
207+
[_sidebar.md](https://raw.githubusercontent.com/MichaelCurrin/docsify-template/master/nested_example/_sidebar.md ':include :type=code')
215208
216209
##### Setup custom sidebar
217210

0 commit comments

Comments
 (0)