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/3rd-party-libraries.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/3rd-party-libraries.md')
| -rw-r--r-- | doc/3rd-party-libraries.md | 14 |
1 files changed, 0 insertions, 14 deletions
diff --git a/doc/3rd-party-libraries.md b/doc/3rd-party-libraries.md deleted file mode 100644 index e6370549..00000000 --- a/doc/3rd-party-libraries.md +++ /dev/null | |||
| @@ -1,14 +0,0 @@ | |||
| 1 | #3rd party libraries | ||
| 2 | ## CSS | ||
| 3 | - Yahoo UI [CSS Reset](http://yuilibrary.com/yui/docs/cssreset/)[](.html) | ||
| 4 | - resets default CSS properties for all HTML elements (overriding browsers' default values) | ||
| 5 | - ensures custom CSS stylessheets will provide the same results on all browsers | ||
| 6 | |||
| 7 | ## Javascript | ||
| 8 | - [Awesomeplete](https://leaverou.github.io/awesomplete/) ([GitHub](https://github.com/LeaVerou/awesomplete)) - autocompletion in input forms[](.html) | ||
| 9 | - [bLazy](http://dinbror.dk/blazy/) ([GitHub](https://github.com/dinbror/blazy)) - lazy loading for thumbnails[](.html) | ||
| 10 | - [qr.js](http://neocotic.com/qr.js/) ([GitHub](https://github.com/neocotic/qr.js)) - QR code generation[](.html) | ||
| 11 | |||
| 12 | ## PHP | ||
| 13 | - [shaarli/netscape-bookmark-parser](https://github.com/shaarli/netscape-bookmark-parser) - Netscape bookmark parser[](.html) | ||
| 14 | - [RainTPL](https://github.com/rainphp/raintpl) - HTML templating for PHP[](.html) | ||