mirror of
https://github.com/tiennm99/HugoBlox-kit.git
synced 2026-10-12 22:14:08 +00:00
demo: change Tutorials to Courses and add List of Courses
Perhaps a more common use case of the docs layout. See #109
This commit is contained in:
1 parent
8a6d151efb
commit
c9cd1afefb
9 files changed
+95
-65
No files matched your search
+2
-2
@@ -8,8 +8,8 @@
|
||||
# JavaScript
|
||||
|
||||
[js.jQuery]
|
||||
version = "3.3.1"
|
||||
sri = "sha512-+NqPlbbtM1QqiK8ZAo4Yrj2c4lNQoGv8P79DPtKzj++l5jnN39rHA/xsqn8zE9l0uSoxaCdrOgFs6yjyfbBxSg=="
|
||||
version = "3.4.1"
|
||||
sri = "sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo="
|
||||
url = "https://cdnjs.cloudflare.com/ajax/libs/jquery/%s/jquery.min.js"
|
||||
[js.highlight]
|
||||
version = "9.12.0"
|
||||
|
||||
@@ -24,8 +24,8 @@
|
||||
weight = 40
|
||||
|
||||
[[main]]
|
||||
name = "Tutorials"
|
||||
url = "tutorial/"
|
||||
name = "Courses"
|
||||
url = "courses/"
|
||||
weight = 50
|
||||
|
||||
[[main]]
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
+++
|
||||
title = "Courses"
|
||||
|
||||
# Optional featured image (relative to `static/img/` folder).
|
||||
[header]
|
||||
image = ""
|
||||
caption = ""
|
||||
+++
|
||||
@@ -0,0 +1,61 @@
|
||||
+++
|
||||
# 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 # Position of this course in course index. Comment out to order by date instead.
|
||||
|
||||
# Page title
|
||||
title = "Overview"
|
||||
|
||||
date = 2018-09-09T00:00:00 # Date published
|
||||
# lastmod = 2018-09-09T00:00:00 # Date modified
|
||||
|
||||
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.
|
||||
[menu.example]
|
||||
name = "Overview" # Declare this menu item as a parent with ID `name`.
|
||||
weight = 1 # Position of link in menu.
|
||||
+++
|
||||
|
||||
## 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>]`.
|
||||
+1
-1
@@ -13,7 +13,7 @@ weight = 1
|
||||
|
||||
# Add menu entry to sidebar.
|
||||
linktitle = "Tips 1-2" # Menu text - remove to use page title instead.
|
||||
[menu.tutorial]
|
||||
[menu.example]
|
||||
parent = "Example Topic" # ID of parent menu entry.
|
||||
weight = 1 # Position of link in menu.
|
||||
+++
|
||||
+1
-1
@@ -13,7 +13,7 @@ weight = 2
|
||||
|
||||
# Add menu entry to sidebar.
|
||||
linktitle = "Tips 3-4" # Menu text - remove to use page title instead.
|
||||
[menu.tutorial]
|
||||
[menu.example]
|
||||
parent = "Example Topic" # ID of parent menu entry.
|
||||
weight = 2 # Position of link in menu.
|
||||
+++
|
||||
@@ -1,51 +0,0 @@
|
||||
+++
|
||||
title = "Overview"
|
||||
|
||||
date = 2018-09-09T00:00:00 # Date published
|
||||
# lastmod = 2018-09-09T00:00:00 # Date modified
|
||||
|
||||
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.
|
||||
[menu.tutorial]
|
||||
name = "Overview" # Declare this menu item as a parent with ID `name`.
|
||||
weight = 1 # Position of link in menu.
|
||||
+++
|
||||
|
||||
## Flexibility
|
||||
|
||||
This feature can be used for publishing content such as:
|
||||
|
||||
* **Project or software documentation**
|
||||
* **Online courses**
|
||||
* **Tutorials**
|
||||
|
||||
The `tutorial` folder may be renamed. For example, we can rename it to `docs` for software/project documentation or `course` for creating an online course.
|
||||
|
||||
## Delete tutorials
|
||||
|
||||
**To remove these pages, delete the `tutorial` folder and see below to delete the associated menu link.**
|
||||
|
||||
## Update site menu
|
||||
|
||||
After renaming or deleting the `tutorial` 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 = "Tutorials"
|
||||
url = "tutorial/"
|
||||
weight = 50
|
||||
```
|
||||
|
||||
Or, if you are creating an online course, you can rename the `tutorial` folder to `course` and update the associated *Tutorials* menu configuration to:
|
||||
|
||||
```toml
|
||||
[[main]]
|
||||
name = "My Course"
|
||||
url = "course/"
|
||||
weight = 50
|
||||
```
|
||||
@@ -1,9 +1,3 @@
|
||||
{{ if .Params.widgets }}
|
||||
|
||||
{{ partial "widget_page.html" . }}
|
||||
|
||||
{{ else }}
|
||||
|
||||
{{ partial "header.html" . }}
|
||||
{{ partial "navbar.html" . }}
|
||||
|
||||
@@ -34,5 +28,3 @@
|
||||
</div>
|
||||
{{ partial "footer_container.html" . }}
|
||||
{{ partial "footer.html" . }}
|
||||
|
||||
{{ end }}
|
||||
@@ -0,0 +1,20 @@
|
||||
{{ partial "header.html" . }}
|
||||
{{ partial "navbar.html" . }}
|
||||
|
||||
{{ partial "page_header.html" . }}
|
||||
|
||||
<div class="universal-wrapper">
|
||||
{{ with .Content }}
|
||||
<div class="article-style" itemprop="articleBody">{{ . }}</div>
|
||||
{{ end }}
|
||||
<ul>
|
||||
{{ if gt (len .Sections) 0}}
|
||||
{{ range .Sections }}
|
||||
<li><h5><a href="{{.RelPermalink}}">{{.LinkTitle}}</a></h5> {{with .Params.summary}}<p>{{. | plainify | emojify}}</p>{{end}}</li>
|
||||
{{end}}
|
||||
{{end}}
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
{{ partial "footer_container.html" . }}
|
||||
{{ partial "footer.html" . }}
|
||||
Reference in new issue
Block a user