From 773f9c913120186c4fa7967e8761f468a35a507d Mon Sep 17 00:00:00 2001 From: vjeantet Date: Sat, 29 Aug 2020 17:28:28 +0200 Subject: update README --- .gitignore | 2 ++ README.md | 14 ++++++++------ 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 66b1f45..54e061a 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,5 @@ /exampleSite/public/ /hugo-0* /notes.md +/hugoBasicExample/ +/.idea/ diff --git a/README.md b/README.md index 8de0d41..3565033 100644 --- a/README.md +++ b/README.md @@ -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. ![Overview](https://github.com/vjeantet/hugo-theme-docport/raw/master/images/tn.png) @@ -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) -- cgit v1.2.3