Skip to content

kieran-ryan/leabhar-cliste

Repository files navigation

leabhar-cliste

Pipeline status pre-commit.ci status LICENSE Prettier

Programming practices, principles and concepts.

Visit the webpage - built using Material for MkDocs.

Building the Docs

To build the site from source, clone the repo and run the following commands:

pip install --requirement requirements.txt
mkdocs build

To serve and access the site from your browser run:

mkdocs serve

Contributing

Contributions to this project are most welcome. Feel free to create an issue or to raise a Pull Request.

It is recommended to use Visual Studio Code and pre-commit when working with the source code, which are pre-configured within the project.

pip install --requirement requirements.txt
pre-commit install

License

leabhar-cliste is licensed under the MIT License.