https://github.com/erickchacon/scholar-docs

Hugo theme for project documentation using Bootstrap 5.
https://github.com/erickchacon/scholar-docs

bootstrap hugo-theme

Last synced: 3 days ago
JSON representation

Hugo theme for project documentation using Bootstrap 5.

• Host: GitHub
• URL: https://github.com/erickchacon/scholar-docs
• Owner: ErickChacon
• License: gpl-3.0
• Created: 2020-05-01T10:02:50.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-17T12:12:34.000Z (about 1 month ago)
• Last Synced: 2024-11-15T15:25:37.221Z (5 days ago)
• Topics: bootstrap, hugo-theme
• Language: HTML
• Homepage:
• Size: 479 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Scholar-docs

## About

[Hugo](https://gohugo.io/) theme using [Bootstrap 5](https://getbootstrap.com/)

to show documentation.

![Webpage example](web-example.png)

## Features

- It creates a expandable sidebar using all the files inside the `content`

  folder. This way you can easily navigate all the pages of your

  project. Each folder should contain an `_index.html` file with a `title` on

  the `yaml` section.

- You can remove the sidebar setting up the parameter `sidebar = false` in the

  `config.toml` file.

- The `_index.html` or `_index.md` main file of the webpage can contain a list

  of authors and webpages to be shown in the webpage.

- It includes a sticky header. You can define the desired links into the

  header. These elements should be defined in `[menu.main]` on the

  `config.toml` file.

- It includes a sticky footer. You can use social media links on the footer

  defining `[params.social]` on the `config.toml` file. The icons are used from

  `fontawesome`.

## Examples

Check the `config-example.toml` to define the desired attributes.