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

github.com/mattbutton/silhouette-hugo.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.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bf5e07f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+# Hugo Silhouette Theme
+
+A theme for [Hugo](https://gohugo.io), created by [Matt Button](https://www.mattbutton.com).
+
+Based on [Bootstrap 4.1](https://getbootstrap.com/).
+
+### Home Page
+
+![screenshot](https://raw.githubusercontent.com/mattbutton/silhouette-hugo/master/github-content/screenshot-home.jpg)
+
+### Post without a feature image
+
+![screenshot](https://raw.githubusercontent.com/mattbutton/silhouette-hugo/master/github-content/screenshot-post-nobanner.jpg)
+
+### Post with a feature image
+
+![screenshot](https://raw.githubusercontent.com/mattbutton/silhouette-hugo/master/github-content/screenshot-post-banner.png)
+
+### Footer
+
+![screenshot](https://raw.githubusercontent.com/mattbutton/silhouette-hugo/master/github-content/screenshot-post-footer.png)
+
+## About the theme
+
+Hi I'm [Matt Button](https://www.mattbutton.com), the creator of the Hugo Silhoutte theme.
+
+I've been a fan of [Hugo](https://gohugo.io) for many years.
+
+Back in 2016, inspired by the theme on [Troy Hunt's blog](https://www.troyhunt.com/), I hacked together a custom Hugo theme for [my personal blog](https://www.mattbutton.com) using Bootstrap 3.
+
+In 2018 I rebuilt the theme using [Bootstrap 4.1](https://getbootstrap.com/), and decided to share it with the Hugo community under the name "Silhouette Hugo".
+
+The silhouette image is taken from [this photo](https://unsplash.com/photos/85J99sGggnw) by Karl Magnuson.
+
+## Usage
+
+Create a new Hugo site by typing
+
+```
+ $ hugo new site <SITENAME>
+```
+
+Then clone this repository:
+
+```
+ $ cd <SITENAME>/themes
+ $ git clone https://github.com/mattbutton/silhouette-hugo.git
+```
+
+Now take a look at the exampleSite folder and you're ready to go!
+
+## License
+
+This theme is provided under the [MIT License](https://github.com/mattbutton/silhouette-hugo/blob/master/LICENSE).
+
+If you use this theme, please provide attribution.
+
+
+
+