diff --git a/README.md b/README.md index b592284040e0a22d81051002da1e52d2c527749b..3aa58110876312b9b8b67ff7875afa7c61ae8417 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,6 @@ https://github.com/getpelican/pelican-themes/tree/master/pelican-bootstrap3 https://help.farbox.com/pygments.html ## Deployer + +## @TODO +- https://github.com/getpelican/pelican-plugins/tree/master/assets diff --git a/content/cri/documentation.md b/content/cri/documentation.md index d8c2251afbbffbe66cc56a2029f48b1e1b69934a..ca6c8e3ee465c4c53ddcaeec3c59f7de648467d0 100644 --- a/content/cri/documentation.md +++ b/content/cri/documentation.md @@ -1,30 +1,46 @@ -Title: Les documentations cri et utilisateur pour ISIMA/LIMOS +Title: Les documentations cri et utilisateur pour l'ISIMA Date: 2017-05-16 10:20 Status: Published -Tags: doc, admin, www +Tags: doc, mkdocs -$e=mc^2$ +[TOC] -La [doc cri](https://doc.cri.isima.fr/) et la [doc user](https://doc.isima.fr/) de l'ISIMA/LIMOS sont toutes les deux rédigées avec le [projet MkDocs](http://www.mkdocs.org/). ```mkdocs``` permet de générer une documenation html statique à partir de simples fichiers textes au format [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). +## Pourquoi deux nouvelles documentations? -L'idée est de centraliser et surtout de mettre à jour les documentations historiques +L'idée est de centraliser et surtout de mettre à jour les documentations existantes pour l'ISIMA * [http://com.isima.fr/cri/infoadmin](http://com.isima.fr/cri/infoadmin) * [System Operations Center](http://192.168.100.7/PluXml/) * [isima wiki / intranet](http://com.isima.fr/cri) -La [doc cri](https://doc.cri.isima.fr/) est à usage restreint et nécessite donc une authentification avec le compte utilisateur Active Directory. +Si une autre source de documentation vous paraît pertinente n'hésitez pas à la soumettre à [cri@isima.fr](mailto:cri@isima.fr) -Tous les membres de l'ISMA et du LIMOS sont invités à contribuer à ces documentations via les repository git dédiés sur [https://gitlab.isima.fr](https://gitlab.isima.fr) +La [documentation cri aka **doc-cri**](https://doc.cri.isima.fr/) est à usage restreint et nécessite donc une authentification avec le compte utilisateur Active Directory. Précisément elle est réservée aux seuls enseignants chercheurs ou personnels de l'ISIMA ou du LIMOS. -* [https://gitlab.isima.fr/cri/doc-user](https://gitlab.isima.fr/cri/doc-user) -* [https://gitlab.isima.fr/cri/doc-cri](https://gitlab.isima.fr/cri/doc-cri) +La [documentation utilisateur aka **doc-user**](https://doc.isima.fr/) est consultable par tout un chacun. -## Modifier la documentation [doc cri](https://doc.cri.isima.fr/) ou [doc user](https://doc.isima.fr/) +## Comment sont faites ces deux documentations? -### 1.Installer l'environnement +[doc-cri](https://doc.cri.isima.fr/) et [doc-user](https://doc.isima.fr/) sont toutes deux écrite avec le [projet MkDocs](http://www.mkdocs.org/), +issu du monde python et largement utilisé dans le monde de l'open source. -#### Prérequis +mkdocs est un module python qui permet à partir d'un code source (une arborescence de fichiers textes au format [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)) de générer des fichiers html statiques présentés dans une charte graphique fonctionnelle et unifiée. + +Les codes source + +* <i class="fa fa-gitlab" aria-hidden="true"></i> + [https://gitlab.isima.fr/cri/doc-user](https://gitlab.isima.fr/cri/doc-user) pour [**doc-cri**](https://doc.cri.isima.fr/) +* <i class="fa fa-gitlab" aria-hidden="true"></i> + [https://gitlab.isima.fr/cri/doc-cri](https://gitlab.isima.fr/cri/doc-cri) pour [**doc-user**](https://doc.isima.fr/) + + sont consultables et modifiables sur le [<i class="fa fa-gitlab" aria-hidden="true"></i> + gitlab de l'ISIMA](https://gitlab.isima.fr) par les seuls enseignants chercheurs ou personnels de l'ISIMA ou du LIMOS doté d'un compte Active Directory. + +> Toutes les contributions, corrections ou suggestions sont les bienvenues: une documentation à jour est un gain de temps pour tous au quotidien + +## Modifier [**doc-cri**](https://doc.cri.isima.fr/) ou [**doc-user**](https://doc.isima.fr/) + +### Prérequis * [python](https://www.python.org/) >= 2.6 ([installation](http://www.mkdocs.org/#installing-python)) * [pip](https://pypi.python.org/pypi/pip) ([installation](https://pip.pypa.io/en/stable/installing/)) diff --git a/content/ispconfig/gitlab.yml b/content/gitlab/gitlab.md similarity index 100% rename from content/ispconfig/gitlab.yml rename to content/gitlab/gitlab.md diff --git a/content/ispconfig/markdown b/content/tech/markdown.md similarity index 100% rename from content/ispconfig/markdown rename to content/tech/markdown.md diff --git a/pelicanconf.py b/pelicanconf.py index ff2cd999317332951a9f7ff4000930ff74dc5590..4b75ce699e139b50ea885e8403a086137984672e 100644 --- a/pelicanconf.py +++ b/pelicanconf.py @@ -73,7 +73,7 @@ CC_LICENSE_COMMERCIAL = "no" # comment CC_* vars and uncommment CUSTOM LICENSE TO ENABLE IT -DISQUS_SITENAME = 'https://limos.isima.fr/~mazenod' +DISQUS_SITENAME = 'limos' DISPLAY_TAGS_ON_SIDEBAR = True TAG_CLOUD_STEPS = 8 @@ -94,9 +94,15 @@ DISPLAY_CATEGORIES_ON_MENU = False THEME = os.path.dirname(os.path.abspath(__file__)) + "/themes/limos" JINJA_ENVIRONMENT = {'extensions': ['jinja2.ext.i18n']} PLUGIN_PATHS = [os.path.dirname(os.path.abspath(__file__)) + '/plugins'] +# @todo https://github.com/getpelican/pelican-plugins/tree/master/assets PLUGINS = ['i18n_subsites', 'tag_cloud', 'tipue_search', 'extract_toc', 'math_render'] MARKDOWN = {'extensions': ['toc']} I18N_TEMPLATES_LANG = 'en' +I18N_SUBSITES = { + 'fr': { + 'Summary': 'Table des matières', + } + } # https://bootswatch.com/ SHOW_ARTICLE_AUTHOR = False SHOW_ARTICLE_CATEGORY = True diff --git a/themes/limos/templates/article.html b/themes/limos/templates/article.html index 957d9e7ae9295f43583180cd9c119a2286492b69..ab22c796d728e7afac926d4936b7d783ee2d1920 100644 --- a/themes/limos/templates/article.html +++ b/themes/limos/templates/article.html @@ -85,6 +85,13 @@ {% include "includes/article_info.html" %} </div> </div> + {% if article.toc %} + <nav class="toc well well-sm"> + <h3>{{ _('Table des Matières')}}</h3> + {{ article.toc }} + </nav> + {% endif %} + <hr /> {{ article.content }} </div> <!-- /.entry-content -->