Files
fission-src/Documentation/docs-site/themes/docdock/exampleSite/content/_index.md
T
2017-09-08 19:13:41 -07:00

2.8 KiB

+++ title = "DocDock Theme for Hugo" description = "" date = "2017-04-24T18:36:24+02:00"

+++

Hugo docDock theme

Hugo-theme-docdock {{%icon fa-github%}} is a theme for Hugo, a fast and modern static website engine written in Go. Hugo is often used for blogs, this theme is fully designed for documentation.

This theme is a partial porting of the Learn theme of matcornic {{%icon fa-github%}}.

{{%panel%}}docDock works with a "page tree structure" to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "content-organisation/_index.md"%}}) {{%/panel%}}

Main features

  • [Search]({{%relref "search/_index.md" %}})
  • Unlimited menu levels
  • [Generate RevealJS presentation]({{%relref "page-slide.md"%}}) from markdown (embededed or fullscreen page)
  • Automatic next/prev buttons to navigate through menu entries
  • [Image resizing, shadow...]({{%relref "create-page/page-images.md" %}})
  • [Attachments files]({{%relref "shortcodes/attachments.md" %}})
  • [List child pages]({{%relref "shortcodes/children/_index.md" %}})
  • [Excerpt]({{%relref "shortcodes/excerpt.md"%}}) ! Include segment of content from one page in another
  • [Mermaid diagram]({{%relref "shortcodes/mermaid.md" %}}) (flowchart, sequence, gantt)
  • [Icons]({{%relref "shortcodes/icon.md" %}}), [Buttons]({{%relref "shortcodes/button.md" %}}), [Alerts]({{%relref "shortcodes/alert.md" %}}), [Panels]({{%relref "shortcodes/panel.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.md" %}}), [Expand]({{%relref "shortcodes/expand.md" %}})
  • [customizable look and feel]({{%relref "content-organisation/customize-style/_index.md"%}}), [theme variants]({{%relref "content-organisation/customize-style/theme-variants.md"%}})

Contribute to this documentation

Feel free to update this content, just click the Edit this page link displayed on top right of each page, and pullrequest it {{%alert%}}Your modification will be deployed automatically when merged.{{%/alert%}}

Documentation website

This current documentation has been statically generated with Hugo with a simple command : hugo -t docdock -- source code is available here at GitHub {{%icon fa-github%}}

{{% panel theme="success" header="Automated deployments" footer="Netlify builds, deploys, and hosts frontends." %}} Automatically published and hosted thanks to Netlify.

Read more about Automated HUGO deployments with Netlify {{% /panel %}}