Skip to content

Commit d37df4c

Browse files
committed
docs: demo page
1 parent 753823e commit d37df4c

File tree

3 files changed

+29
-4
lines changed

3 files changed

+29
-4
lines changed

docs/modules/ROOT/nav.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
* xref:index.adoc[]
2+
* xref:demos.adoc[]
23
* xref:install.adoc[]
34
* xref:usage.adoc[]
45
* xref:config-file.adoc[]

docs/modules/ROOT/pages/demos.adoc

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
= Demos
2+
3+
A few examples of reference documentation generated with MrDocs are available in https://mrdocs.com/demos/:
4+
5+
|===
6+
| 4+| *Multi-Page* 4+| *Single-Page*
7+
| *Library* | *Asciidoc* | *Rendered Asciidoc* | *HTML* | *XML* | *Asciidoc* | *Rendered Asciidoc* | *HTML* | *XML*
8+
9+
| https://github.com/boostorg/url[Boost.URL]
10+
| https://mrdocs.com/demos/develop/boost-url/multi/adoc/[🔗]
11+
| https://mrdocs.com/demos/develop/boost-url/multi/adoc-asciidoc/[🔗]
12+
| https://mrdocs.com/demos/develop/boost-url/multi/html/[🔗]
13+
| https://mrdocs.com/demos/develop/boost-url/multi/xml/[🔗]
14+
| https://mrdocs.com/demos/develop/boost-url/single/adoc/[🔗]
15+
| https://mrdocs.com/demos/develop/boost-url/single/adoc-asciidoc/[🔗]
16+
| https://mrdocs.com/demos/develop/boost-url/single/html/[🔗]
17+
| https://mrdocs.com/demos/develop/boost-url/single/xml/[🔗]
18+
19+
| https://github.com/boostorg/scope[Boost.Scope]
20+
| https://mrdocs.com/demos/develop/boost-scope/multi/adoc/[🔗]
21+
| https://mrdocs.com/demos/develop/boost-scope/multi/adoc-asciidoc/[🔗]
22+
|
23+
|
24+
| https://mrdocs.com/demos/develop/boost-scope/single/adoc/[🔗]
25+
| https://mrdocs.com/demos/develop/boost-scope/single/adoc-asciidoc/[🔗]
26+
|
27+
|
28+
|===

docs/modules/ROOT/pages/usage.adoc

-4
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,6 @@ At this step, you can also add any other flags you want to pass to `cmake`, such
6565
By running CMake with the `CMAKE_EXPORT_COMPILE_COMMANDS` flag, you will generate a `compile_commands.json` file in your build directory.
6666
This file contains all the information mrdocs needs to generate the documentation.
6767

68-
== Demos
69-
70-
A few examples of reference documentation generated with MrDocs are available in https://mrdocs.com/demos/.
71-
7268
== MrDocs configuration file
7369

7470
The `mrdocs.yml` configuration file contains information about the project that is not available in the `compile_commands.json` file or from the command line.

0 commit comments

Comments
 (0)