summaryrefslogtreecommitdiff
path: root/themes/hugo-whisper-theme/exampleSite/content/docs/example/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'themes/hugo-whisper-theme/exampleSite/content/docs/example/index.md')
-rw-r--r--themes/hugo-whisper-theme/exampleSite/content/docs/example/index.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/themes/hugo-whisper-theme/exampleSite/content/docs/example/index.md b/themes/hugo-whisper-theme/exampleSite/content/docs/example/index.md
new file mode 100644
index 0000000..cdef287
--- /dev/null
+++ b/themes/hugo-whisper-theme/exampleSite/content/docs/example/index.md
@@ -0,0 +1,35 @@
+---
+title: 'Hugo Whisper'
+date: 2019-02-11T19:27:37+10:00
+weight: 6
+---
+
+Whisper is a minimal documentation theme built for Hugo. The design & functionality is intentionally minimal.
+
+<!--more-->
+
+## Quickstart
+
+Copy or git clone this theme into the sites themes folder `mynewsite/themes`
+
+```
+hugo new site whisper
+git clone https://github.com/jugglerx/hugo-whisper-theme.git
+```
+
+### Code Highlighting
+
+Whisper uses Hugo's in-built code highlighting with a github style code highlighting theme. https://gohugo.io/content-management/syntax-highlighting/
+
+You can insert code snippets in any markdown file by using standard code fences syntax ie:
+
+```js
+function myFunction() {
+ var x = document.getElementById('myDIV');
+ if (x.style.display === 'none') {
+ x.style.display = 'block';
+ } else {
+ x.style.display = 'none';
+ }
+}
+```