Practicalli book-name

██████╗ ██████╗  █████╗  ██████╗████████╗██╗ ██████╗ █████╗ ██╗     ██╗     ██╗
██╔══██╗██╔══██╗██╔══██╗██╔════╝╚══██╔══╝██║██╔════╝██╔══██╗██║     ██║     ██║
██████╔╝██████╔╝███████║██║        ██║   ██║██║     ███████║██║     ██║     ██║
██╔═══╝ ██╔══██╗██╔══██║██║        ██║   ██║██║     ██╔══██║██║     ██║     ██║
██║     ██║  ██║██║  ██║╚██████╗   ██║   ██║╚██████╗██║  ██║███████╗███████╗██║
╚═╝     ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝   ╚═╝   ╚═╝ ╚═════╝╚═╝  ╚═╝╚══════╝╚══════╝╚═╝

NOTE: Ascii Art Generator: https://patorjk.com/software/taag/#p=display&f=ANSI%20Shadow&t=Astro%205

Book Overview

Book status

Creative commons license

This work is licensed under a Creative Commons Attribution 4.0 ShareAlike License (including images & stylesheets).

Contributing

Issues and pull requests are most welcome although it is the maintainers discretion as to if they are applicable. Please detail issues as much as you can. Pull requests are simpler to work with when they are specific to a page or at most a section. The smaller the change the quicker it is to review and merge.

Please read the detailed Practicalli contributing page before raising an issue or pull request to avoid disappointment.

• Current Issues
• Current pull requests

By submitting content ideas and corrections you are agreeing they can be used in any work by Practicalli under the Creative Commons Attribution ShareAlike 4.0 International license. Attribution will be detailed via GitHub contributors.

Sponsor Practicalli

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

Star History

GitHub Actions

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 and builds the static pages for the book. Those pages are committed to the gh-pages branch and served by GitHub.

Local development

Install the latest version of Material for MkDocs using the Python pip package manager, within a Python virutal environonment.

Fork the GitHub repository and clone that fork to your computer,

git clone https://github.com/<your-github-account>/<repository>.git

The book includes a Makefile with tasks to set up the Python virtual environment and install Material for MkDocs.

NOTE: Use the command defined in the relevant Makefile task if not using the make command.

Set up the virtual environment in ~/.local/venv/

make python-venv

Install Material for MkDocs and all the plugins used for Practicalli books and websites.

make mkdocs-install

Run a local build of the book, service the pages on localhost:7777

make docs

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