diff --git a/CHANGELOG.md b/CHANGELOG.md index 7f1028e..6657502 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,7 @@ Critical items to know are: - changed behaviour ## [master](https://github.com/vsoch/docsy-jekyll/tree/master) + - adding more verbose example for subfolders (0.0.24) - sidebar fix to support multiple top level menus (0.0.23) - added support for github_branch (default 'master') in config (0.0.22) - adding support in footer to icon and link to linkedin url (0.0.21) diff --git a/VERSION b/VERSION index df5db66..b056f41 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.0.23 +0.0.24 diff --git a/_docs/getting-started.md b/_docs/getting-started.md index 3fe085e..736d54d 100644 --- a/_docs/getting-started.md +++ b/_docs/getting-started.md @@ -50,6 +50,12 @@ Documentation pages should be written in the `docs` folder of the repository, and you are allowed to use whatever level of nesting (subfolders) that works for you! It's a Jekyll [collection](https://jekyllrb.com/docs/collections/), which means that you can add other content (images, scripts) and it will be included for linking to. +To create subfolders with files, you can simply create new markdon files. For example: + + - `_docs/subfolder/example-page.md` renders to `http://localhost:4000/docsy-jekyll/docs/subfolder/example-page/` + - `_docs/subfolder.md` renders to `http://localhost:4000/docsy-jekyll/docs/subfolder/` + +And the page you are reading now renders from `_docs/getting-started.md` #### Organization @@ -78,7 +84,7 @@ getting started page for sherlock: ``` [Here](example-page) is an example link to a relative path of a file (`example-page.md`) -in the same directory, and from that page you can test linking to a subfoldr. +in the same directory, and from that page you can test linking to a subfolder. In the case of not having a subfolder, we could write the link out directly: ``` diff --git a/_docs/subfolder.md b/_docs/subfolder.md new file mode 100644 index 0000000..f19122d --- /dev/null +++ b/_docs/subfolder.md @@ -0,0 +1,9 @@ +--- +title: The Subfolder Page +description: An example of a subfolder page. +--- + +# A Subfolder Page. + +This is an example of a page that doesn't have a permalink defined, and +is not included in the table of contents (`_data/toc.yml`). diff --git a/_docs/subfolder/example-page.md b/_docs/subfolder/example-page.md index f1f8a11..3f58762 100644 --- a/_docs/subfolder/example-page.md +++ b/_docs/subfolder/example-page.md @@ -1,6 +1,6 @@ --- title: A Nested Page -description: An example of a a nested page in a subfolder. +description: An example of a nested page in a subfolder. --- # A Nested Page