summaryrefslogtreecommitdiffstats
path: root/doc/markdown.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2018-04-22 09:57:29 (GMT)
committerGitHub <noreply@github.com>2018-04-22 09:57:29 (GMT)
commit75e5504f79336e84cda3fc5f478d3dc82b1700a6 (patch)
treecb29ae7b61dcc9f5f41d949a0b62701c706833d1 /doc/markdown.doc
parentbdd3b3ddcdd85bb41c4cf0bf7830bcd5c2c9db42 (diff)
parent19e2abe877cafbe4ab56cbc50d913dfaf249e450 (diff)
downloadDoxygen-75e5504f79336e84cda3fc5f478d3dc82b1700a6.zip
Doxygen-75e5504f79336e84cda3fc5f478d3dc82b1700a6.tar.gz
Doxygen-75e5504f79336e84cda3fc5f478d3dc82b1700a6.tar.bz2
Merge pull request #688 from albert-github/feature/bug_md_toc_docu
Added note for usage of [TOC] together with Markdown headers
Diffstat (limited to 'doc/markdown.doc')
-rw-r--r--doc/markdown.doc3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/markdown.doc b/doc/markdown.doc
index a0e7574..92612ca 100644
--- a/doc/markdown.doc
+++ b/doc/markdown.doc
@@ -300,6 +300,9 @@ to produce a table of contents at the start of the page, listing all sections.
Note that using `[TOC]` is the same as using a
\ref cmdtableofcontents "\\tableofcontents" command.
+Note that the \ref cfg_toc_include_headings "TOC_INCLUDE_HEADINGS" has to be set
+to a value > 0 otherwise no table of contents is shown when using \ref md_headers "Markdown Headers".
+
\subsection md_tables Tables
Of the features defined by "Markdown Extra" is support for