34 lines
1.1 KiB
Markdown
34 lines
1.1 KiB
Markdown
# 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`.
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
- [Visit the documentation](http://docdock.netlify.com/) |