doc theme

2017-09-08 19:13:41 -07:00
parent f2a9f8a938
commit cb861e72a9
300 changed files with 38823 additions and 0 deletions
@@ -0,0 +1,34 @@
+# Hugo docDock Theme
+
+This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Matcornic Learn theme](https://github.com/matcornic/hugo-theme-learn/).
+
+Visit the [theme documentation](http://docdock.netlify.com/) to see what is going on. It is actually built with this theme.
+
+# Main features
+
+- Search
+- **Unlimited menu levels**
+- RevealJS presentation from markdown (embededed or fullscreen page)
+- Attachments files
+- List child pages
+- Include segment of content from one page in another (Excerpt)
+- Automatic next/prev buttons to navigate through menu entries
+- Mermaid diagram
+- Icons, Buttons, Alerts, Panels, Tip/Note/Info/Warning boxes
+- Image resizing, shadow...
+- Customizable look and feel
+
+## Installation
+Navigate to your themes folder in your Hugo site and use the following commands:
+```
+$ cd themes
+$ git clone https://github.com/vjeantet/hugo-theme-docdock.git docdock
+```
+
+Check that your Hugo version is minimum `0.25` with `hugo version`.
+
+![Overview](https://github.com/vjeantet/hugo-theme-docdock/raw/master/images/tn.png)
+
+## Usage
+
+- [Visit the documentation](http://docdock.netlify.com/)