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

github.com/10mohi6/hugo-theme-simple-blog.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md61
1 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f3de0b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+# simple-blog
+
+simple-blog is a simple blog theme for [hugo](http://gohugo.io/).
+
+![screenshot](https://raw.githubusercontent.com/10mohi6/hugo-theme-simple-blog/master/images/screenshot.png)
+
+## Features
+
+- based on [bootstrap](https://getbootstrap.com/)
+- pagination
+- tags
+- categories
+- js unused
+
+## Installation
+
+```shell
+$ git clone https://github.com/10mohi6/hugo-theme-simple-blog themes/simple-blog
+```
+
+## Usage
+
+```shell
+$ hugo server -t simple-blog
+```
+
+## Configuration
+
+config.toml
+
+```toml
+theme = "simple-blog"
+baseURL = "<your site url>"
+title = "<your site title>"
+copyright = "© 2020 copyright text."
+paginate = 3
+languageCode = "en"
+DefaultContentLanguage = "en"
+enableInlineShortcodes = true
+footnoteReturnLinkContents = "^"
+
+[menu]
+
+ [[menu.main]]
+ identifier = "about"
+ name = "About"
+ url = "/about/"
+ weight = 10
+
+[taxonomies]
+category = "categories"
+tag = "tags"
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request \ No newline at end of file