Giter Club home page Giter Club logo

hugo-mc-docs's Introduction

MakinaCorpus documentation Theme for hugo

initialize a new project based on this theme

mkdir hugoproject
cd hugoproject
git init
git submodule add https://github.com/makinacorpus/hugo-mc-docs.git themes/hugo-mc-docs
cd themes/hugo-mc-docs/exampleSite
cp -r ../.gitignore * ../../..
cd ../../..
git add .
$EDITOR config.yaml
git commit -am init

install/usage

  • non docker

    themes/hugo-mc-docs/bin/control.sh install
# This start the gulp development server after build)
themes/hugo-mc-docs/bin/control.sh serve

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

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

  • Create a content

    ./bin/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

hugo-mc-docs's People

Contributors

kiorky avatar sebcorbin avatar regilero avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.