Skip to content

Learn Git and GitHub without any code!

Using the Hello World guide, you’ll start a branch, write comments, and open a pull request.

Read the guide
  • Watch
    Notifications
  • Fork

    Fork hugo-academic

    If this dialog fails to load, you can visit the fork page directly.

Permalink
Branch: master
Find file Copy path
Find file Copy path
1 contributor

Users who have contributed to this file

62 lines (46 sloc) 1.96 KB
linktitle summary weight title date lastmod draft toc type menu
An Example Course
Learn how to use Academic's docs layout for publishing online courses, software documentation, and tutorials.
1
Overview
2018-09-09T00:00:00Z
2018-09-09T00:00:00Z
false
true
docs
example
name weight
Overview
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:

[[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:

[[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>].

You can’t perform that action at this time.