chore: add exampleSite
And associated files for Hugo Themes Site
This commit is contained in:
62
exampleSite/content/courses/example/_index.md
Normal file
62
exampleSite/content/courses/example/_index.md
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
# Course title, summary, and position.
|
||||
linktitle: An Example Course
|
||||
summary: Learn how to use Academic's docs layout for publishing online courses, software documentation, and tutorials.
|
||||
weight: 1
|
||||
|
||||
# Page metadata.
|
||||
title: Overview
|
||||
date: "2018-09-09T00:00:00Z"
|
||||
lastmod: "2018-09-09T00:00:00Z"
|
||||
draft: false # Is this a draft? true/false
|
||||
toc: true # Show table of contents? true/false
|
||||
type: docs # Do not modify.
|
||||
|
||||
# Add menu entry to sidebar.
|
||||
# - name: Declare this menu item as a parent with ID `name`.
|
||||
# - weight: Position of link in menu.
|
||||
menu:
|
||||
example:
|
||||
name: Overview
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Flexibility
|
||||
|
||||
This feature can be used for publishing content such as:
|
||||
|
||||
* **Online courses**
|
||||
* **Project or software documentation**
|
||||
* **Tutorials**
|
||||
|
||||
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 tutorials
|
||||
|
||||
**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>]`.
|
||||
Reference in New Issue
Block a user