Skip to content

Commit 02261f5

Browse files
committed
docs: Update nested example
1 parent 525f045 commit 02261f5

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ The tutorial is available in two forms:
1212
- Github Pages: [docs site](https://michaelcurrin.github.io/docsify-template/#/). This also live demo of the kind of site you would have after completing the tutorial.
1313
- Project docs: View the docs as plain markdown format in the repo, either locally or on Github. See the [docs](/docs) directory.
1414

15-
The tutorial references the [quickstart](/quickstart) at the project root.
15+
The tutorial references the [quickstart](/quickstart) directory at the project root.
16+
17+
See also the [Nested Example](/nested_example/README.md) section for understanding links in markdown and the sidebar.
1618

1719
## License
1820

β€Žnested_example/README.mdβ€Ž

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Nested example
22

3-
This directory contains an example of the structure of a Docsify docs directory that uses two levels of markdown files. This links in the sidebar file and the markdown files demonstrate proper use of links.
3+
The files in this directory demonstrate what file linking and nested docs structure look like when using a custom sidebar.
4+
5+
This [nested_example](/nested_example) was tested using a _Docsify_ server, but was reduced to just the content and sidebar file to serve as a lean example that does not run.

0 commit comments

Comments
Β (0)