diff options
| author | vjeantet <valere.jeantet@gmail.com> | 2020-08-29 18:28:28 +0300 |
|---|---|---|
| committer | vjeantet <valere.jeantet@gmail.com> | 2020-08-29 18:28:28 +0300 |
| commit | 773f9c913120186c4fa7967e8761f468a35a507d (patch) | |
| tree | 6d3d53dfc800c947b08d20c7091238e1c238e99c /README.md | |
| parent | 5e89e39b9a3bb32b7f42f2b9b366d7c936ba1d35 (diff) | |
update README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 8 insertions, 6 deletions
@@ -1,9 +1,9 @@ # Hugo docPort Theme DocPort, a professional documentation theme built for [Hugo](https://gohugo.io/). -it provides a simple navigation, search engine, a high level of configuration and a bunch of [shortcodes](https://docport.netlify.app/shortcodes/) +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, children, notice, alers, diagrams...). -This project is actively being maintained +This project is actively being maintained, and integrate easily with netlify CMS for static content authoring without leaving the browser.  @@ -12,15 +12,17 @@ This project is actively being maintained 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. +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/). @@ -28,12 +30,12 @@ This theme is maintained by its author Valère JEANTET with the help from these # 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 +* all [docdock theme](https://github.com/vjeantet/hugo-theme-docdock) contributors and forkers. This theme is mainly based on their work ! -## Usage +## 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) |