Our docs are available in: manuals.gisce.net
Table Of Contents
$ mkvirtualenv powerp-docs
$ git clone git@github.com:gisce/powerp-docs.git
$ cd powerp-docs
$ pip install -r requirements.txt
$ apt-get install gettext
$ apt-get install poedit
Atom
With the extensions:
For more detailed info, check the wiki.
Set all file titles in the mkdocs.yml files. For each language, there should be a translation.
To translate the text use:
./translate.sh
To merge with master, you'll probably have conflicts with the pofile. There's quite a story behind, [you can learn more on the wiki].
Just use the following:
./merge.sh
Remember to commit after changes are applied
You should check the wiki to learn more about this.
The essential commands are:
With the "-f" argument, we specify the config file to be used.
i.e.:
$ mkdocs serve
$ mkdocs serve -f mkdocs_es.yml
$ mkdocs build
$ mkdocs build -f mkdocs_es.yml
Markdown extensions:
NOTE: All filenames and directories should be in Spanish
We have 5 categories:
For images we use _static
folder inside the category with a subfolder for the
same name as Markdown file of the Section.
i.e.:
For distri/atr.md
we have distri/_static/atr/image1.png
Our travis testing includes:
Using alt text (or the source) to find the images.
Add your own css in the docs/extra/css/images.css
directory.
The css may have the format:
img[alt="TextFromAlt"]{}
img[src="https://github.com/gisce/powerp-docs/raw/master/TextFromSrc"]{}
And the markdown image should be like:
![TextFromAlt](TextFromSrc)
If using alt as a CSS class, remember to use an image-defining name and also translate it. (i.e. alt="icon" [icon->icona / icon->icono])
We are not using them, but we can add footnotes.
To add footnotes, first it's needed to add footnotes extension to config.yml:
vim mkdocs.yml
Then append the extension:
markdown_extensions:
- footnotes
Use it in any .md document as in footnotes docs:
Footnotes[^1] have a label[^@#$%] and the footnote's content.
[^1]: This is a footnote content.
[^@#$%]: A footnote on the label: "@#$%".
[^1]:
The first paragraph of the definition.
Paragraph two of the definition.
> A blockquote with
> multiple lines.
a code block
A final paragraph.