.. title:: Galaxie Docs, survival md conversion tool

============================
Galaxie Docs Documentation
============================
.. figure::  images/logo_galaxie.png
   :align:   center

The Project
-----------
**Galaxie Docs** is a free software Tool Kit for create MarkDown to HTML file.

Then the lib is write in **Python**

Installation
------------

**Pre Version**: ``pip install galaxie-docs``

**Dev Version**: ``pip install -i https://test.pypi.org/simple/ galaxie-docs``

Documentation:
--------------
**Readthedocs link:** http://galaxie-docs.readthedocs.io


The Mission
-----------
Provide text based tool for create html file during survival period.

Contribute
----------
You welcome !!!

- Issue Tracker: https://gitlab.com/Tuuux/galaxie-docs/issues
- Source Code: https://gitlab.com/Tuuux/galaxie-docs


Screenshots
-----------
Coming soon

Example
-------
```bash
glxdoc-md2html ./tests/README.md ./tests/README.html
```

Features
--------
* CSS is includ inside html file
* Code coloration
* EveryMarkDown extension is enable
* Defensive code style

Roadmap
-------
Be the intenal Document wrapper for **Galaxie-Curses** lib .

* glxdoc-html2md

Thanks
------
To everyone i have interrest to it project, copy it, use it, diffuse it , and have fun ...

Documentations
--------------
.. toctree::
   :maxdepth: 2

   GLXDocs
   modules

e-Curses** is a Text Based **GTK+** like, then the GTK+ Doc is the **roadmap**.

License
-------
GNU GENERAL PUBLIC LICENSE Version 3


See the LICENCE_

.. _LICENCE: https://gitlab.com/Tuuux/galaxie-curses/blob/master/LICENSE

All contributions to the project source code ("patches") SHALL use the same license as the project.

Indices and tables
------------------
* :ref:`genindex`
* :ref:`search`