blob: 710d4598127aabe2b3e045a0a5ad2083223af445 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
# Hugo docPort Theme
DocPort, a professional documentation theme built for [Hugo](https://gohugo.io/).
it provides a simple navigation, automatic search engine, a high level of configuration and a bunch of [shortcodes](https://docport.netlify.app/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](http://docport.netlify.com/) 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](https://docport.netlify.app/getting-start/installation/)
# 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](https://docport.netlify.app/docport-theme/credits/).
# Credits
Many thanks to
* @matcornic for its inspiration and OpenSource spirit ! . See his great theme [Hugo Learn Theme](https://github.com/matcornic/hugo-theme-learn)
* all [docdock theme](https://github.com/vjeantet/hugo-theme-docdock) contributors and forkers.
This theme is mainly based on their work !
## See Also
- [Visit the documentation](https://docport.netlify.app/)
- [Hugo docs](https://gohugo.io/getting-started/configuration/)
- [Git submodules](https://git-scm.com/docs/git-submodule)
|
