lzxqaq / hugo-theme-docport

Hugo docPort Theme

DocPort, a professional documentation theme built for Hugo. it provides a simple navigation, automatic search engine, a high level of configuration and a bunch of shortcodes crafted for documentation (attachment, presentations, child pages, notice, alerts, diagrams...).

This project is actively being maintained, and integrate easily with netlify CMS for static content authoring without leaving the browser.

Demo

Visit the theme documentation to see what is going on. It is actually built with this theme.

Quick Start

• Add the repository into your Hugo Project repository as a submodule, git submodule add https://github.com/vjeantet/hugo-theme-docport.git themes/hugo-theme-docport.
• Configure your config.toml. You may the prepared one for this theme. The config.toml inside the exampleSite is also a good reference.
• Build your site with hugo server and see the result at http://localhost:1313/.

More on instalation methods exist, see more information in the live demo website

Documentation

DocPort has its own user guide https://docport.netlify.app

License

DocPort is licensed under the MIT license, see the LICENSE.md file for details.

Maintenance

This theme is maintained by its author Valère JEANTET with the help from these awesome contributors.

Credits

Many thanks to

• @matcornic for its inspiration and OpenSource spirit ! . See his great theme Hugo Learn Theme
• all docdock theme contributors and forkers.

This theme is mainly based on their work !

See Also

• Visit the documentation
• Hugo docs
• Git submodules