Generate HTML documentation using MkDocs (WIP)

[github/shaarli/Shaarli.git] / doc / md / Theming.md

diff --git a/doc/Theming.md b/doc/md/Theming.md
similarity index 79%
rename from doc/Theming.md
rename to doc/md/Theming.md
index 23877e5d9c57856ee30fb9108f778696fcc8936a..ae68db383a20b66218eee19405beba2636e3647b 100644 (file)
--- a/doc/Theming.md
+++ b/doc/md/Theming.md
@@ -1,11 +1,12 @@
-#Theming
 ## Foreword
+
 There are two ways of customizing how Shaarli looks:
 
 1. by using a custom CSS to override Shaarli's CSS
 2. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources
 
 ## Custom CSS
+
 Shaarli's appearance can be modified by adding CSS rules to:
 - Shaarli < `v0.9.0`: `inc/user.css`
 - Shaarli >= `v0.9.0`: `data/user.css`
@@ -14,9 +15,10 @@ This file allows overriding rules defined in the template CSS files (only add ch
 
 **Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli.
 
-See also [Download CSS styles from an OPML list](Download-CSS-styles-from-an-OPML-list.html)
+See also [[Download CSS styles from an OPML list]]
 
 ## Themes
+
 _WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental._
 
 Installation:
@@ -28,24 +30,29 @@ Installation:
     - Shaarli >= `v0.9.0`: select the theme through the _Tools_ page
 
 ## Community CSS & themes
+
 ### Custom CSS
-- [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for Shaarli[](.html)
-- [shaarli/shaarli-themes](https://github.com/shaarli/shaarli-themes)[](.html)
+
+- [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for Shaarli
+- [shaarli/shaarli-themes](https://github.com/shaarli/shaarli-themes)
 
 ### Themes
-- [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli[](.html)
-- [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli[](.html)
-- [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme[](.html)
-- [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli[](.html)
-- [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli[](.html)
-- [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone[](.html)
-- [ManufacturaInd/shaarli-2004licious-theme](https://github.com/ManufacturaInd/shaarli-2004licious-theme) - A template/theme as a humble homage to the early looks of the del.icio.us site[](.html)
+
+- [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli
+- [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli
+- [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme
+- [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli
+- [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli
+- [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone
+- [ManufacturaInd/shaarli-2004licious-theme](https://github.com/ManufacturaInd/shaarli-2004licious-theme) - A template/theme as a humble homage to the early looks of the del.icio.us site
 
 ### Shaarli forks
-- [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template[](.html)
-- [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance[](.html)
+
+- [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template
+- [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance
 
 ## Example installation: AlbinoMouse theme
+
 With the following configuration:
 - Apache 2 / PHP 5.6
 - user sites are enabled, e.g. `/home/user/public_html/somedir` is served as `http://localhost/~user/somedir`
@@ -70,7 +77,7 @@ Get config written:
 - fill the install form
 - log in to Shaarli
 
-Edit Shaarli's [configuration|Shaarli configuration](configuration|Shaarli-configuration.html):
+Edit Shaarli's [[configuration|Shaarli configuration]]:
 ```bash
 # the file should be owned by Apache, thus not writeable => sudo
 $ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php