|
|
@@ -0,0 +1,12 @@
|
|
|
+# Hogo-Book Starter
|
|
|
+
|
|
|
+This is a template repository to bootstrap your documentation site with Hugo-Book theme. It contains minimal configured from the start hugo site.
|
|
|
+1. To use this repository create a new repository from this template
|
|
|
+2. Run `git clone --recurse-submodules https://github.com/{org/user}/{repository}`
|
|
|
+3. Enter newly created directory `cd {repository}`
|
|
|
+4. Run hugo `hugo server`
|
|
|
+
|
|
|
+And you are ready to write docs!
|
|
|
+
|
|
|
+# Configuration options
|
|
|
+Please refer to [Hugo Documentation](https://gohugo.io/configuration/) and [Theme Source](https://github.com/alex-shpak/hugo-book/blob/main/exampleSite/hugo.yaml#L70)
|
Alex Shpak