A series of articles covering a practical approach to software development practices and tooling.
██████╗ ██████╗ █████╗ ██████╗████████╗██╗ ██████╗ █████╗ ██╗ ██╗ ██╗
██╔══██╗██╔══██╗██╔══██╗██╔════╝╚══██╔══╝██║██╔════╝██╔══██╗██║ ██║ ██║
██████╔╝██████╔╝███████║██║ ██║ ██║██║ ███████║██║ ██║ ██║
██╔═══╝ ██╔══██╗██╔══██║██║ ██║ ██║██║ ██╔══██║██║ ██║ ██║
██║ ██║ ██║██║ ██║╚██████╗ ██║ ██║╚██████╗██║ ██║███████╗███████╗██║
╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚══════╝╚═╝
All sponsorship funds are used to support the continued development of Practicalli series of books and videos, although most work is done at personal cost and time.
Thanks to Cognitect, Nubank and a wide range of other sponsors for your continued support
Contributions are most welcome for Practicalli Books and project. However, as this is a personal journal, this specific repository does not take pull requests.
Please read the detailed Practicalli contributing page to help you to help Practicalli.
The megalinter GitHub actions will run when a pull request is created,checking basic markdown syntax.
A review of the change will be carried out by the Practicalli team and the PR merged if the change is acceptable.
The Publish Book GitHub action will run when PR's are merged into main (or the Practicalli team pushes changes to the default branch).
Publish book workflow installs Material for MkDocs version 9
Install mkdocs version 9 using the Python pip package manager
pip install mkdocs-material=="9.*"
Install the plugins used by the Practicalli site using Pip (these are also installed in the GitHub Action workflow)
pip3 install mkdocs-material mkdocs-callouts mkdocs-glightbox mkdocs-git-revision-date-localized-plugin mkdocs-redirects pillow cairosvg
pillow and cairosvg python packages are required for Social Cards
Fork the GitHub repository and clone that fork to your computer,
git clone https://github.com/<your-github-account>/<repository>.git
Run a local server from the root of the cloned project
make docs
The website will open at http://localhost:8000
If making smaller changes, then only rebuild the content that changes, speeding up the local development process
make docs-changed
NOTE: navigation changes may not be correctly reflected without reloading the page in the web browser or carrying out a full
make docs
build