diff options
| author | nodiscc <nodiscc@gmail.com> | 2017-01-26 18:52:54 +0100 |
|---|---|---|
| committer | nodiscc <nodiscc@gmail.com> | 2017-06-18 00:19:49 +0200 |
| commit | 53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch) | |
| tree | f8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/Home.md | |
| parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
| download | Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip | |
Generate HTML documentation using MkDocs (WIP)
MkDocs is a static site generator geared towards building project documentation.
Documentation source files are written in Markdown, and configured with a single YAML file.
* http://www.mkdocs.org/
* http://www.mkdocs.org/user-guide/configuration/
Ref. #312
* remove pandoc-generated HTML documentation
* move markdown doc to doc/md/,
* mkdocs.yml:
* generate HTML doc in doc/html
* add pages TOC/ordering
* use index.md as index page
* Makefile: remove execute permissions from generated files
* Makefile: rewrite htmlpages GFM to markdown conversion using sed:
awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks
* Add mkdocs.yml to .gitattributes, exclude this file from release archives
* Makefile: rename: htmldoc -> doc_html target
* run make doc: pull latest markdown documentation from wiki
* run make htmlpages: update html documentation
Diffstat (limited to 'doc/Home.md')
| -rw-r--r-- | doc/Home.md | 14 |
1 files changed, 0 insertions, 14 deletions
diff --git a/doc/Home.md b/doc/Home.md deleted file mode 100644 index 38413f24..00000000 --- a/doc/Home.md +++ /dev/null | |||
| @@ -1,14 +0,0 @@ | |||
| 1 | #Home | ||
| 2 | # Shaarli wiki | ||
| 3 | |||
| 4 | Welcome to the [Shaarli](https://github.com/shaarli/Shaarli/) wiki | ||
| 5 | |||
| 6 | Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. | ||
| 7 | |||
| 8 | For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).[](.html) | ||
| 9 | |||
| 10 | If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) ([archive](https://github.com/shaarli/Shaarli/issues/44)) or read the current [issues](https://github.com/shaarli/Shaarli/issues). If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).[](.html) | ||
| 11 | |||
| 12 | If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin).[](.html) | ||
| 13 | |||
| 14 | _Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the `doc/` directory of your Shaarli installation._ | ||