diff options
Diffstat (limited to 'deps/edown/README.md')
| -rw-r--r-- | deps/edown/README.md | 22 |
1 files changed, 5 insertions, 17 deletions
diff --git a/deps/edown/README.md b/deps/edown/README.md index df8e8ec..73f628b 100644 --- a/deps/edown/README.md +++ b/deps/edown/README.md @@ -4,10 +4,8 @@ Copyright (c) 2014 Ulf Wiger - __Authors:__ [`ulf@wiger.net`](mailto:ulf@wiger.net). - Status: ------ More-or-less readable Markdown can be generated. @@ -51,11 +49,11 @@ It is also possible to add the branch information specifically: `{top_level_readme, {File, BaseHref, Branch}}`, although this shouldn't be necessary as long as edown can derive the branch name from git. -Using Atlassian Stash as target -------------------------------- +Using Atlassian Stash or Gitlab as target +----------------------------------------- -The option `{edown_target, github | stash}` can be used to control which -is the intended host repository. This affects how links are rewritten in +The option `{edown_target, github | stash | gitlab}` can be used to control +which is the intended host repository. This affects how links are rewritten in order to find related files and stay on the correct branch. The default value is `github`. @@ -63,6 +61,7 @@ The default value is `github`. Note that at the moment, the [Markdown viewer plugin](https://bitbucket.org/atlassianlabs/stash-markdown-viewer-plugin) will be needed in order to render the generated documentation as Markdown on Stash. + Github customizations ===================== `pre` tags are converted into github "fenced" code blocks, i.e. @@ -167,14 +166,3 @@ See [bin/MARKEDOC-README.md](http://github.com/uwiger/edown/blob/master/bin/MARK **Linux**`$ sed -r -f markedoc.sed <markdown file> > <edoc file>` - -## Modules ## - - -<table width="100%" border="0" summary="list of modules"> -<tr><td><a href="http://github.com/uwiger/edown/blob/master/doc/edown_doclet.md" class="module">edown_doclet</a></td></tr> -<tr><td><a href="http://github.com/uwiger/edown/blob/master/doc/edown_layout.md" class="module">edown_layout</a></td></tr> -<tr><td><a href="http://github.com/uwiger/edown/blob/master/doc/edown_lib.md" class="module">edown_lib</a></td></tr> -<tr><td><a href="http://github.com/uwiger/edown/blob/master/doc/edown_make.md" class="module">edown_make</a></td></tr> -<tr><td><a href="http://github.com/uwiger/edown/blob/master/doc/edown_xmerl.md" class="module">edown_xmerl</a></td></tr></table> - |