makinacorpus/hugo-mc-docs

Name: hugo-mc-docs

Owner: Makina Corpus

Description: Hugo makinacorpus branded theme for rendering documentation

Created: 2017-03-09 01:01:02.0

Updated: 2017-03-15 16:16:07.0

Pushed: 2017-07-07 13:23:47.0

Homepage: http://hugo-mc-docs.makina-corpus.com/

Size: 23199

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

MakinaCorpus documentation Theme for hugo

initialize a new project based on this theme

r hugoproject
ugoproject
init
submodule add https://github.com/makinacorpus/hugo-mc-docs.git themes/hugo-mc-docs
hemes/hugo-mc-docs/exampleSite
r ../.gitignore * ../../..
./../..
add .
TOR config.yaml
commit -am init

install/usage

• non docker

  es/hugo-mc-docs/bin/control.sh install
  is start the gulp development server after build)
  es/hugo-mc-docs/bin/control.sh serve
  

• Via docker, note that the script will start the gulp development server after build

  es/hugo-mc-docs/bin/docker.sh
  

• Create a content

  n/control.sh hugo new content/doc.md
  

Notes

• This theme install its own hugo, node & virtualenv flavors on local folders along the project (./var).
• naviguation is inspired from Material themes
• Livesearch is enabled throrough lunr.js and a special crafted (via hugo at build time) JSON file.

Credits

• Largely inspired from Mkdocs, material themes around and hugo docs theme itself