Merge pull request #2 from django-commons/flesh-out-mkdocs

Flesh out mkdocs

Author: williln

.gitignore

@@ -0,0 +1 @@
+site/

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files

README.md

@@ -0,0 +1,25 @@
+# django-commons.github.io
+
+The Django Commons docs are deployed at [django-commons.org](https://django-commons.org).
+
+## MkDocs Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Local Development
+
+- Create a Python 3.12 virtual environment
+- Run `pip install mkdocs`
+- Run `mkdocs serve`
+
+### pre-commit
+
+You don't have to use pre-commit. But if you choose to:
+
+- Run `pip install pre-commit`
+- Run `pre-commit install`
+
+This will install pre-commit. Then, before you commit, run `pre-commit run` to run pre-commit and check your changed files for linting errors.

docs/index.md

@@ -0,0 +1,7 @@
+# Django Commons
+
+## Repositories
+
+- [django-commons/membership](https://github.com/django-commons/membership)
+- [django-commons/best-practices](https://github.com/django-commons/best-practices)
+- [django-commons/controls](https://github.com/django-commons/controls)

mkdocs.yml

@@ -0,0 +1,5 @@
+site_name: Django Commons
+repo_url: https://github.com/django-commons/django-commons.github.io
+markdown_extensions:
+  - toc:
+      permalink: "#"