aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authoretienne <admin@MacBook-Pro-de-Admin.local>2014-10-21 23:35:24 +0200
committeretienne <admin@MacBook-Pro-de-Admin.local>2014-10-21 23:35:24 +0200
commit667e11c4ec3835d959aab1797647bd0a49869674 (patch)
tree84c6c5f20686574009f1dccc0f27a7192ff165e7 /README.md
Init commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md78
1 files changed, 78 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ec43ce2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,78 @@
+# Hugo base theme
+
+Hugo theme based on [gohugo](https://gohugo.io)
+
+## How to use
+ - Place a image in `static/img/`
+ - Create posts to display your services. Use the follow as an example:
+
+### post
+
+```toml
++++
+date = 2014-10-13T20:07:19Z
+draft = true
+title = "First"
+description = "Ceci est mon premier post \n bla bla bla"
+weight = 1
+icon = "pacman"
++++
+
+Hello first post
+```
+### carrousel
+
+
+```toml
++++
+date = 2014-10-13T19:54:21Z
+draft = true
+title = "About"
+weight = 5
+icon = "circlestar"
+[[carousel]]
+ quote = "First quote"
+ author ="John Do"
+ url = ""
+ quote_date = "13 August"
+[[carousel]]
+ quote = "Second quote"
+ author ="Nhoj Od"
+ url = ""
+ quote_date = "14 August"
++++
+```
+
+
+
+## Demo
+View gohugo.io theme in action [here](https://gohugo.io)
+
+
+===
+
+Work also with YAML header
+
+For more Hugo details, read [documentation](http://jekyllrb.com/).
+
+## Config
+
+exemple of config.toml file
+```toml
+baseurl = "http://yourSiteHere"
+languageCode = "fr-fr"
+title = "my new web site"
+[params]
+ description = "I <3 making web site"
+ mainIcon = "/img/hugo.png"
+
+[[params.social]]
+ title = "twitter"
+ url = "https://twitter.com/SBootstrap"
+[[params.social]]
+ title = "github"
+ url = "https://github.com/IronSummitMedia/startbootstrap"
+[[params.social]]
+ title = "linkedin"
+ url = ""
+```