From 4c0ad756cee4f40de960081ac82c838b4ad1e131 Mon Sep 17 00:00:00 2001 From: "Mohammad-Habib.Javaid" Date: Tue, 16 Jul 2024 14:53:04 +0200 Subject: [PATCH 1/2] Markdown documentation added --- doc/2.0/manual/intro.wiki | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/2.0/manual/intro.wiki b/doc/2.0/manual/intro.wiki index 1933c56..1d183f0 100644 --- a/doc/2.0/manual/intro.wiki +++ b/doc/2.0/manual/intro.wiki @@ -137,6 +137,7 @@ Here are some common, widely used by Ocsigen's documentation extensions: ==Basic usage {{{ $ ohow file.wiki # generates file.html +$ ohow --out-language=md file.wiki # generate file.md $ ohow -o somename.html file.wiki # generates somename.html $ ohow --help # shows help $ ohow --version # shows version @@ -399,6 +400,7 @@ The command ##dop## accepts the following short options: |=Name |=Option |=Value |=Default value|=Description| |Config |{{{-c}}}|File |---|Configuration file| |Config type|{{{-t}}}|{{{json}}} or {{{plain}}}|{{{plain}}}|Configuration file type (format)| +|Output type|{{{-g}}}|{{{md}}} or {{{html}}} |{{{html}}}|Output file type| |Clean |{{{-k}}}|Flag |---|Do not clean wikis after compilation| |Inferred |{{{-i}}}|Flag |---|Print inferred configuration| |Used |{{{-u}}}|Flag |---|Print used (final) configuration| From dd1f480c82e0b83b9f99baccc78e377d721a8796 Mon Sep 17 00:00:00 2001 From: "Mohammad-Habib.Javaid" Date: Mon, 26 Aug 2024 12:10:22 +0200 Subject: [PATCH 2/2] adding the precision that it's possible to export in markdown --- doc/2.0/manual/intro.wiki | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/2.0/manual/intro.wiki b/doc/2.0/manual/intro.wiki index 1d183f0..ada4169 100644 --- a/doc/2.0/manual/intro.wiki +++ b/doc/2.0/manual/intro.wiki @@ -39,6 +39,8 @@ <> is also composable, it can be integrated into a CI/CD process so you can automate the deployment of your website. Rebuild and deploy on each commit! + + Markdown export is available, but it's experimental and may include a significant amount of HTML. >> ==@@id="install"@@Installation