Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown documentation added #144

Open
wants to merge 2 commits into
base: wikidoc
Choose a base branch
from
Open

Markdown documentation added #144

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c0ad75
Markdown documentation added
mhjd Jul 16, 2024
dd1f480
adding the precision that it's possible to export in markdown
mhjd Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/2.0/manual/intro.wiki
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@

<<span class="monospace"|html_of_wiki>> 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
Expand Down Expand Up @@ -137,6 +139,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
Expand Down Expand Up @@ -399,6 +402,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|
Expand Down