dev: convert to material mkdocs project

LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

Makefile

@@ -0,0 +1,75 @@
+# ------------------------------------------
+# Practicalli: Makefile
+#
+# Consistent set of targets to support local book development
+# ------------------------------------------
+
+# .PHONY: ensures target used rather than matching file name
+# https://makefiletutorial.com/#phony
+.PHONY: all clean docs lint pre-commit-check test
+
+
+# ------- Makefile Variables --------- #
+
+# run help if no target specified
+.DEFAULT_GOAL := help
+
+# Column the target description is printed from
+HELP-DESCRIPTION-SPACING := 24
+
+
+MEGALINTER_RUNNER = npx mega-linter-runner --flavor documentation --env "'MEGALINTER_CONFIG=.github/config/megalinter.yaml'" --remove-container
+
+# Makefile file and directory name wildcard
+EDN-FILES := $(wildcard *.edn)
+
+# ------------------------------------ #
+
+
+# ------  Quality Checks  ------------ #
+
+pre-commit-check: lint
+
+lint:  ## Run MegaLinter with custom configuration (node.js required)
+	$(info --------- MegaLinter Runner ---------)
+	$(MEGALINTER_RUNNER)
+
+
+lint-fix:  ## Run MegaLinter with custom configuration (node.js required)
+	$(info --------- MegaLinter Runner ---------)
+	$(MEGALINTER_RUNNER) --fix
+
+lint-clean:  ## Clean MegaLinter report information
+	$(info --------- MegaLinter Clean Reports ---------)
+	- rm -rf ./megalinter-reports
+
+# ------------------------------------ #
+
+
+# --- Documentation Generation  ------ #
+
+docs:  ## Build and run mkdocs in local server
+	$(info --------- Mkdocs Local Server ---------)
+	mkdocs serve --dev-addr localhost:7777
+
+docs-changed:  ## Build only changed files and run mkdocs in local server
+	$(info --------- Mkdocs Local Server ---------)
+	mkdocs serve --dirtyreload --dev-addr localhost:7777
+
+docs-build:  ## Build mkdocs
+	$(info --------- Mkdocs Local Server ---------)
+	mkdocs build
+
+# ------------------------------------ #
+
+
+# ------------ Help ------------------ #
+
+# Source: https://nedbatchelder.com/blog/201804/makefile_help_target.html
+
+help:  ## Describe available tasks in Makefile
+	@grep '^[a-zA-Z]' $(MAKEFILE_LIST) | \
+	sort | \
+	awk -F ':.*?## ' 'NF==2 {printf "\033[36m  %-$(HELP-DESCRIPTION-SPACING)s\033[0m %s\n", $$1, $$2}'
+
+# ------------------------------------ #

README.md

@@ -1,33 +1,88 @@
-# Practicalli - Gitbook Template
+# Practicalli sustainable-life
 
-![GitHub Workflow Status](https://img.shields.io/github/workflow/status/practicalli/gitbook-template/build-book?style=for-the-badge)
+```none
+██████╗ ██████╗  █████╗  ██████╗████████╗██╗ ██████╗ █████╗ ██╗     ██╗     ██╗
+██╔══██╗██╔══██╗██╔══██╗██╔════╝╚══██╔══╝██║██╔════╝██╔══██╗██║     ██║     ██║
+██████╔╝██████╔╝███████║██║        ██║   ██║██║     ███████║██║     ██║     ██║
+██╔═══╝ ██╔══██╗██╔══██║██║        ██║   ██║██║     ██╔══██║██║     ██║     ██║
+██║     ██║  ██║██║  ██║╚██████╗   ██║   ██║╚██████╗██║  ██║███████╗███████╗██║
+╚═╝     ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝   ╚═╝   ╚═╝ ╚═════╝╚═╝  ╚═╝╚══════╝╚══════╝╚═╝
+```
 
-GitHub template to create new GitBook projects, as used by Practicalli.
 
-## Overview
+## Book status
 
-Use this repository template to quickly create the structure of a GitBook project, including a GitHub Action to deploy the website to GitHub Pages and generate ebook formats as a release.
+![GitHub issues](https://img.shields.io/github/issues/practicalli/sustainable-life?label=content%20ideas&logo=github)
+![GitHub commit activity](https://img.shields.io/github/commit-activity/y/practicalli/sustainable-life?label=commits&logo=github)
+![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/practicalli/sustainable-life?label=pull%20requests&logo=github)
+[![Publish Book](https://github.com/practicalli/sustainable-life/actions/workflows/publish-book.yaml/badge.svg)](https://github.com/practicalli/sustainable-life/actions/workflows/publish-book.yaml)
+[![MegaLinter](https://github.com/practicalli/sustainable-life/actions/workflows/megalinter.yml/badge.svg)](https://github.com/practicalli/sustainable-life/actions/workflows/megalinter.yml)
 
-The GitBook Action caches the npm plugins to minimise the time taken to run.
 
-## Using the template
+## License and Contributing
 
-Visit the practicalli/gitbook-template repository and select the **Use this Template** button
+<p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/">
+<a href="http://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">
+<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1"></a>
+ <a property="dct:title" rel="cc:attributionURL" href="https://github.com/practicalli/sustainable-life">Practicalli Sustainable Life</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://practical.li">Practicalli</a> is licensed under <a href="http://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY-SA 4.0 </a></p>
 
-Enter the repository name and description for the new GitBook project and select **"Create repository from template"**
+Please [read the Practicalli contributing guide](https://practical.li/contributing) before raising an issue or pull request
 
-Configure the GitBookk project by editing the [`book.json`](book.json) file.
+By submitting content ideas and corrections you are agreeing they can be used in this workshop under the [Creative Commons Attribution ShareAlike 4.0 International license](https://creativecommons.org/licenses/by-sa/4.0/).  Attribution will be detailed via [GitHub contributors](https://github.com/practicalli/sustainable-life/graphs/contributors).
 
-Define the navigation of the book using the [SUMMARY.md](SUMMARY.md) file.
 
-Subsequent pushes of the content to the `main` branch  will create a new version of the website and publish that version on GitHub pages automatically.
+## Sponsor Practicalli
 
-## Publish GitBook PDF, Mobi, Epub formats
+[![Sponsor practicalli-john](https://raw.githubusercontent.com/practicalli/graphic-design/live/buttons/practicalli-github-sponsors-button.png)](https://github.com/sponsors/practicalli-john/)
 
-Generate a new version of each Ebook format by selecting **"Release"** in the new GitHub repository
+The majority of my work is focused on the [Practicalli series of books and videos](https://practical.li/) and an advisory role with several communities
 
-Select **"Create a new Release"** or **"Draft a new Release"**
+Thank you to [Cognitect](https://www.cognitect.com/), [Nubank](https://nubank.com.br/) and a wide range of other [sponsors](https://github.com/sponsors/practicalli-john#sponsors) for your continued support
 
-Define a version, title, and description for the release.
 
-Select **Save**.  A new release of each Ebook should appear within a few minutes (depending on the size of the content).
+## 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 version 9
+
+
+## Local development
+
+Install mkdocs version 9 using the Python pip package manager
+
+```bash
+pip3 install mkdocs-material=="9.5"
+```
+
+Install the plugins used by the Practicalli site using Pip (these are also installed in the GitHub Action workflow)
+
+```bash
+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](https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/)
+
+Fork the GitHub repository and clone that fork to your computer,
+
+```bash
+git clone https://github.com/<your-github-account>/<repository>.git
+```
+
+Run a local server from the root of the cloned project
+
+```bash
+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
+
+```bash
+make docs-changed
+```