docs: demo page

sdkrystian · May 15, 2024 · d37df4c · d37df4c
1 parent 753823e
commit d37df4c
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 4 deletions.
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -1,4 +1,5 @@
 * xref:index.adoc[]
+* xref:demos.adoc[]
 * xref:install.adoc[]
 * xref:usage.adoc[]
 * xref:config-file.adoc[]

diff --git a/docs/modules/ROOT/pages/demos.adoc b/docs/modules/ROOT/pages/demos.adoc
@@ -0,0 +1,28 @@
+= Demos
+
+A few examples of reference documentation generated with MrDocs are available in https://mrdocs.com/demos/:
+
+|===
+|  4+| *Multi-Page* 4+| *Single-Page*
+| *Library* | *Asciidoc* | *Rendered Asciidoc* | *HTML* | *XML* | *Asciidoc* | *Rendered Asciidoc* | *HTML* | *XML*
+
+| https://github.com/boostorg/url[Boost.URL]
+| https://mrdocs.com/demos/develop/boost-url/multi/adoc/[🔗]
+| https://mrdocs.com/demos/develop/boost-url/multi/adoc-asciidoc/[🔗]
+| https://mrdocs.com/demos/develop/boost-url/multi/html/[🔗]
+| https://mrdocs.com/demos/develop/boost-url/multi/xml/[🔗]
+| https://mrdocs.com/demos/develop/boost-url/single/adoc/[🔗]
+| https://mrdocs.com/demos/develop/boost-url/single/adoc-asciidoc/[🔗]
+| https://mrdocs.com/demos/develop/boost-url/single/html/[🔗]
+| https://mrdocs.com/demos/develop/boost-url/single/xml/[🔗]
+
+| https://github.com/boostorg/scope[Boost.Scope]
+| https://mrdocs.com/demos/develop/boost-scope/multi/adoc/[🔗]
+| https://mrdocs.com/demos/develop/boost-scope/multi/adoc-asciidoc/[🔗]
+|
+|
+| https://mrdocs.com/demos/develop/boost-scope/single/adoc/[🔗]
+| https://mrdocs.com/demos/develop/boost-scope/single/adoc-asciidoc/[🔗]
+|
+|
+|===
diff --git a/docs/modules/ROOT/pages/usage.adoc b/docs/modules/ROOT/pages/usage.adoc
@@ -65,10 +65,6 @@ At this step, you can also add any other flags you want to pass to `cmake`, such
 By running CMake with the `CMAKE_EXPORT_COMPILE_COMMANDS` flag, you will generate a `compile_commands.json` file in your build directory.
 This file contains all the information mrdocs needs to generate the documentation.
 
-== Demos
-
-A few examples of reference documentation generated with MrDocs are available in https://mrdocs.com/demos/.
-
 == MrDocs configuration file
 
 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.