Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/the2ne/hugo-frais.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'exampleSite/content/about/index.md')
-rw-r--r--exampleSite/content/about/index.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/exampleSite/content/about/index.md b/exampleSite/content/about/index.md
new file mode 100644
index 0000000..4bb7993
--- /dev/null
+++ b/exampleSite/content/about/index.md
@@ -0,0 +1,66 @@
++++
+title = "About Hugo Frais"
+description = "Hugo Frais, a fresh and french themefor Hugo by Olivier Fredon"
+date = "2016-11-10T11:27:27-04:00"
++++
+# Hugo frais
+
+A fresh and french single column theme for [Hugo](//gohugo.io/).
+
+![Screenshot](https://github.com/the2ne/hugo-frais/blob/master/images/tn.png)
+
+## How to install
+
+Inside the folder of your Hugo site run:
+
+```sh
+$ cd themes
+$ git clone https://github.com/the2ne/hugo-frais
+```
+
+Then update your _config.toml_ file:
+
+```toml
+theme = "hugo-frais"
+```
+
+For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.
+
+
+## Configuration
+
+You can define some social network like:
+
+- [params] **author** *str* : the author's website name;
+- [params] **pseudo** *str* : the author's online pseudonym;
+- [params] **twitter** *str* : Twitter account;
+- [params] **github** *str* : GitHub account;
+- [params] **linkedin** *str* : LinkedIn account;
+
+This will activate meta (OpenGraph and Twitter Card) and menu item.
+
+_./config.toml example:_
+```toml
+[params]
+ author = "Olivier Fredon"
+ pseudo = "the2ne"
+ twitter = "the2ne"
+ github = "the2ne"
+ linkedin = "the2ne"
+```
+
+
+## Contributing
+
+Did you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](//github.com/the2ne/hugo-frais/issues) to let me know. Or make directly a [pull request](//github.com/the2ne/hugo-frais/pulls).
+
+
+## License
+
+This theme is released under the MIT license. For more information read the [License](//github.com/the2ne/hugo-frais/blob/master/LICENSE.md).
+
+
+## Annotations
+
+Thanks to:
+- [Steve Francia](//github.com/spf13) for creating Hugo and the awesome community around the project.