https://github.com/madhuakula/toc-page-hugo-theme
Table of Contents Page (toc-page) is a minimal, single-page theme for Hugo
https://github.com/madhuakula/toc-page-hugo-theme
golang hugo hugo-theme jamstack
Last synced: 4 months ago
JSON representation
Table of Contents Page (toc-page) is a minimal, single-page theme for Hugo
- Host: GitHub
- URL: https://github.com/madhuakula/toc-page-hugo-theme
- Owner: madhuakula
- License: mit
- Created: 2021-06-18T21:08:46.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-18T23:16:16.000Z (about 4 years ago)
- Last Synced: 2024-12-27T02:22:39.418Z (6 months ago)
- Topics: golang, hugo, hugo-theme, jamstack
- Language: HTML
- Homepage: https://toc-page-hugo-theme.vercel.app
- Size: 238 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Table of Contents (TOC) Page theme for Hugo
Table of Contents (TOC) Page is a minimal, single-page theme for Hugo.
## Get the theme
* Run from the root of your Hugo site
```sh
git clone https://github.com/madhuakula/toc-page-hugo-theme.git themes/toc-page
```
> Alternatively, you can include this repository as a [git submodule](https://git-scm.com/docs/gitsubmodules). This makes it easier to update this theme if you have your Hugo site in git as well
```sh
git submodule add https://github.com/madhuakula/toc-page-hugo-theme.git themes/toc-page
```
## Preview the theme
* toc-page theme ships with an fully configured example site. For a quick preview, run the following commands
```sh
cd themes/toc-page/exampleSite/
hugo serve --themesDir ../..
```
* Then visit `http://localhost:1313/` in your browser to view the example site
## Add content
* The following explains how to add content to your Hugo site. You can find sample content in the `exampleSite/` folder
## Configure your site
* From `exampleSite/`, copy `config.toml` to the root folder of your Hugo site and change the fields as you like
## Used By
- [Kubernetes Goat Project](https://github.com/madhuakula/kubernetes-goat)
## Issues
If you have a question, please [open an issue](https://github.com/madhuakula/toc-page-hugo-theme/issues) for help and to help those who come after you. The more information you can provide, the better!
## Contributing
Contributions are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
Licensed under [MIT](LICENSE)
## Acknowledgements
* [Varun AP](https://github.com/apvarun)