Skip to content

Latest commit

 

History

History
100 lines (64 loc) · 3.09 KB

README.md

File metadata and controls

100 lines (64 loc) · 3.09 KB
Raw

DATAMI DOCUMENTATION CONTENT

Website : https://datami-docs.multi.coop

This repo contains all contents for the Datami's documentation website, including the site's architecture : website name, locales, navbar, routes, footers, images, and text contents...

Thoses contents are organized so they could be deployed as a website, thanks to a softawre developped by the digital cooperative multi.

Render those contents as a websitte

🚀   Here you'll find the "multi-site-app" source code to deploy the .md contents contained in this repo.

Organisation

This repo is organized in the following order :

.
├── README.md
├── LICENCE.md
├── config folder: to deploy a website with the `multi-site` app
│   ├── global.md : global config file (md and yaml head)
│   ├── navbar.md : config file for navbar butttons and links (md and yaml head)
│   ├── route.md : config file for routes (md and yaml head)
│   └── footer.md : config file for footer links (md and yaml head)
├── images folder: contains images
├── texts folder : contains all markdown files, including

Deployment

The contents are deployed with Netlify

  • Test deploy : Netlify Status
  • Official deploy : Netlify Status

Mini server for local development

A mini server is writen in the server.py to serve this folder's files, so we could test and develop locally while running multi-site-app

To install the mini-server :

pip install --upgrade pip
python3 -m pip install --user virtualenv
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt

or

sh setup.sh
source venv/bin/activate

To run the server on http://localhost:8800:

python server.py

or

sh run_server.sh

Files will be locally served on :

  • http://localhost:8800/content/<path:folder_path>/<string:filename>
  • http://localhost:8800/statics/<path:folder_path>/<string:filename>

Contributions

If you want to propose somme enhancements to our content please make pull requests against the main branch. We will review that with great pleasure :)

You can also add issues directly in the reop, or add notes or issues from our gitlab "board" page.

Notes / tutorials' section images

Here are the links to the source documents (slides) we used to create the tutorials's images :