/docs

Project general documentation / Documentação geral do projeto

Primary LanguageDockerfileMIT LicenseMIT

Documentation of AcompanhaLegis

This is the repository for the documentation of AcompanhaLegis. We use MkDocs to do it.


Requirements

You must have Docker installed on your machine.

You can find out how to install Docker on it's official website.

Installing and Running

1. Clone the repository

$ git clone https://github.com/AcompanhaLegis/Docs.git

2. Access the repository directory

$ cd docs

3. Build the docker image from Dockerfile

$ sudo docker build -t dockerpython .

3. Run the docker image

$ sudo docker run -p 8080:8080 dockerpython

Done! Now, you can check out the generated documentation live on.

It should be running on: http://127.0.0.1:8080/


License

This project is licensed under the MIT License - see the LICENSE.md file for details.