starters(notes): edit

This commit is contained in:
Geo committed 2022-05-16 12:25:32 +01:00
1 parent da81c3b8fe
commit 77a684a7d2
2 files changed
+6 -84

No files matched your search

+3 -43
View File
@@ -1,5 +1,6 @@
---
# Title, summary, and page position.
title: Chapter 1
linktitle: Chapter 1
summary: Learn how to use Wowchemy's docs layout for publishing online courses, software documentation, and tutorials.
weight: 1
@@ -7,50 +8,9 @@ icon: book
icon_pack: fas
# Page metadata.
title: Chapter 1
date: '2018-09-09T00:00:00Z'
type: book # Do not modify.
toc: false
---
## Flexibility
Document everything!
This feature can be used for publishing content such as:
- **Online courses**
- **Project or software documentation**
- **Tutorials**
- **Notes**
The `courses` folder may be renamed. For example, we can rename it to `docs` for software/project documentation or `tutorials` for creating an online course.
## Delete courses
**To remove these pages, delete the `courses` folder and see below to delete the associated menu link.**
## Update site menu
After renaming or deleting the `courses` folder, you may wish to update any `[[main]]` menu links to it by editing your menu configuration at `config/_default/menus.toml`.
For example, if you delete this folder, you can remove the following from your menu configuration:
```toml
[[main]]
name = "Courses"
url = "courses/"
weight = 50
```
Or, if you are creating a software documentation site, you can rename the `courses` folder to `docs` and update the associated _Courses_ menu configuration to:
```toml
[[main]]
name = "Docs"
url = "docs/"
weight = 50
```
## Update the docs menu
If you use the _docs_ layout, note that the name of the menu in the front matter should be in the form `[menu.X]` where `X` is the folder name. Hence, if you rename the `courses/example/` folder, you should also rename the menu definitions in the front matter of files within `courses/example/` from `[menu.example]` to `[menu.<NewFolderName>]`.
{{< list_children >}}
+3 -41
View File
@@ -1,5 +1,6 @@
---
# Title, summary, and page position.
title: Chapter 2
linktitle: Chapter 2
summary: Learn how to use Academic's docs layout for publishing online courses, software documentation, and tutorials.
weight: 1
@@ -7,48 +8,9 @@ icon: book-reader
icon_pack: fas
# Page metadata.
title: Chapter 2
date: '2018-09-09T00:00:00Z'
type: book # Do not modify.
toc: false
---
## Flexibility
This feature can be used for publishing content such as:
- **Online courses**
- **Project or software documentation**
- **Tutorials**
- **Notes**
The `courses` folder may be renamed. For example, we can rename it to `docs` for software/project documentation or `tutorials` for creating an online course.
## Delete courses
**To remove these pages, delete the `courses` folder and see below to delete the associated menu link.**
## Update site menu
After renaming or deleting the `courses` folder, you may wish to update any `[[main]]` menu links to it by editing your menu configuration at `config/_default/menus.toml`.
For example, if you delete this folder, you can remove the following from your menu configuration:
```toml
[[main]]
name = "Courses"
url = "courses/"
weight = 50
```
Or, if you are creating a software documentation site, you can rename the `courses` folder to `docs` and update the associated _Courses_ menu configuration to:
```toml
[[main]]
name = "Docs"
url = "docs/"
weight = 50
```
## Update the docs menu
If you use the _docs_ layout, note that the name of the menu in the front matter should be in the form `[menu.X]` where `X` is the folder name. Hence, if you rename the `courses/example/` folder, you should also rename the menu definitions in the front matter of files within `courses/example/` from `[menu.example]` to `[menu.<NewFolderName>]`.
{{< list_children >}}