https://github.com/lrntct/hugo-project-doc

Port of aksakalli's jekyll-doc-theme to Hugo
https://github.com/lrntct/hugo-project-doc

bootstrap-sass documentation hugo hugo-theme static-site-generator

Last synced: 5 days ago
JSON representation

Port of aksakalli's jekyll-doc-theme to Hugo

• Host: GitHub
• URL: https://github.com/lrntct/hugo-project-doc
• Owner: lrntct
• License: mit
• Created: 2017-07-06T01:29:34.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-09T16:09:17.000Z (over 7 years ago)
• Last Synced: 2024-08-01T12:17:22.817Z (3 months ago)
• Topics: bootstrap-sass, documentation, hugo, hugo-theme, static-site-generator
• Language: CSS
• Homepage: http://project-doc.netlify.com
• Size: 1.62 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-starred - lrntct/hugo-project-doc - Port of aksakalli's jekyll-doc-theme to Hugo (documentation)

README

        
# Project Docs

A software project theme for [Hugo](https://gohugo.io).

## Quick start

Inside your website's theme directory, install the theme with `git`:

  git clone https://github.com/lrntct/hugo-project-doc.git

Next, take a look in the `exampleSite` folder.

This directory contains an example configuration file and the content for the demo.

It serves as an example setup for your documentation.

Copy its content in the root directory of your website.

Overwrite the existing config file if necessary. 

The style sheets are written in [scss](http://sass-lang.com/) and therefore need to be compiled into CSS before the site could be used.

You can do it like so:

  sass -t compressed _sass/main.scss:static/css/main.css

Hugo includes a development server, so you can view your changes as you go.

Start it up with the following command:

  hugo server

Now you can go to [localhost:1313](http://localhost:1313) and the Material theme should be visible.

To compile your site to the disk, just type `hugo` in the main directory.

## Acknowledgements

This theme is a partial port of the [jekyll-doc-theme](https://github.com/aksakalli/jekyll-doc-theme) from Can Güney Aksakalli.

It takes some snippets from the [DocDock](https://github.com/vjeantet/hugo-theme-docdock)

and [hugo-academic](https://github.com/gcushen/hugo-academic) themes, written by Valere Jeantet and George Cushen, respectively.

This README  is inspired by [hugo-material-docs](https://github.com/digitalcraftsman/hugo-material-docs) from Digitalcraftsman.

## License

The theme is released under the MIT license. Read the [license](https://github.com/lrntct/hugo-project-doc/blob/master/LICENSE.md) for more information.