CiviCRM per a entitats del sector social dels Jesuïtes de Catalunya - Documentació

Aquest repositori conté la documentació dels diferents CRMs de les entitats del sector social dels Jesuïtes i que és accessible a través de l'adreça http://docs.crm.socialsj.cat.

La documentació està construïda mitjançant MkDocs, un generador de llocs web especialment dirigit a l'elaboració de documentació i el codi font de la qual està escrit amb Markdown i configurat amb un únic fitxer de configuració YAML. S'utilitza Mkdocs Material com a tema visual de la documentació.

Requirements

Instal·lar MkDocs i Mkdocs Material per poder compilar el projecte.

pip3 install mkdocs

pip3 install mkdocs-material

pip3 install mkdocs-glightbox

o bé...

pipx install mkdocs

pipx inject mkdocs mkdocs-material mkdocs-material-extensions pymdown-extensions mkdocs-glightbox

Upgrade Mkdocs

pipx upgrade mkdocs

pipx inject mkdocs mkdocs-material mkdocs-material-extensions pymdown-extensions

Desenvolupament

Es pot treballar i consultar una versió local de la documentació executant la següent ordre:

mkdocs serve

Generació

Per tal de generar la documentació en HTML tan sols cal executar la següent ordre:

mkdocs build --clean

Desplegament

Per tal de desplegar la documentació a GitHub Pages tan sols cal executar la següent ordre:

mkdocs gh-deploy