From 1ea743a0bfd5ab3ab74009fdd0fb2db64e8e79d8 Mon Sep 17 00:00:00 2001
From: Thibault Saunier <tsaunier@igalia.com>
Date: Fri, 17 Aug 2018 20:13:08 -0300
Subject: hotdoc: Add documentation

---
 docs/markdown/snippets/hotdoc_module.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 docs/markdown/snippets/hotdoc_module.md

(limited to 'docs/markdown/snippets')

diff --git a/docs/markdown/snippets/hotdoc_module.md b/docs/markdown/snippets/hotdoc_module.md
new file mode 100644
index 0000000..4662ea2
--- /dev/null
+++ b/docs/markdown/snippets/hotdoc_module.md
@@ -0,0 +1,22 @@
+## Hotdoc module
+
+A new module has been written to ease generation of [hotdoc](https://hotdoc.github.io/) based
+documentation. It supports complex use cases such as hotdoc subprojects (to create documentation
+portals) and makes it straight forward to leverage full capabilities of hotdoc.
+
+Simple usage:
+
+``` meson
+hotdoc = import('hotdoc')
+
+hotdoc.generate_doc(
+  'foobar',
+  c_smart_index: true,
+  project_version: '0.1',
+  sitemap: 'sitemap.txt',
+  index: 'index.md',
+  c_sources: ['path/to/file.c'],
+  languages: ['c'],
+  install: true,
+)
+```
\ No newline at end of file
-- 
cgit v1.1