📚 [index] Convert to Markdown using MyST (#1207)

* 📚 [codeofconduct] Convert to Markdown using MyST

* 📚 [contributing] Use YAML front matter in include directive

* 📚 [index] Convert to Markdown using MyST

* 📚 [css] Remove unused stylesheet and unsupported rst-class directive

* 📚 [index] Use YAML front matter in toctree directive

* 📚 [README] Avoid name conflict in black and pre-commit references

* 📚 [index] Use native include directive for badges and features

Author: cjolowicz

README.md

@@ -9,12 +9,12 @@
 [![Read the documentation][readthedocs badge]][readthedocs page]
 [![Tests][github actions badge]][github actions page]
 [![Codecov][codecov badge]][codecov page]<br>
-[![pre-commit enabled][pre-commit badge]][pre-commit]
-[![Black codestyle][black badge]][black]
+[![pre-commit enabled][pre-commit badge]][pre-commit project]
+[![Black codestyle][black badge]][black project]
 [![Contributor Covenant][contributor covenant badge]][code of conduct]
 
-[black]: https://github.com/psf/black
 [black badge]: https://img.shields.io/badge/code%20style-black-000000.svg
+[black project]: https://github.com/psf/black
 [calver badge]: https://img.shields.io/badge/calver-YYYY.MM.DD-22bfda.svg
 [calver]: http://calver.org/
 [code of conduct]: https://github.com/cjolowicz/cookiecutter-hypermodern-python/blob/main/CODE_OF_CONDUCT.md
@@ -26,8 +26,8 @@
 [github page]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
 [license badge]: https://img.shields.io/github/license/cjolowicz/cookiecutter-hypermodern-python
 [license]: https://opensource.org/licenses/MIT
-[pre-commit]: https://pre-commit.com/
 [pre-commit badge]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
+[pre-commit project]: https://pre-commit.com/
 [python version badge]: https://img.shields.io/pypi/pyversions/cookiecutter-hypermodern-python-instance
 [readthedocs badge]: https://img.shields.io/readthedocs/cookiecutter-hypermodern-python/latest.svg?label=Read%20the%20Docs
 [readthedocs page]: https://cookiecutter-hypermodern-python.readthedocs.io/

docs/_static/custom.css

@@ -0,0 +1,3 @@
+```{include} ../CODE_OF_CONDUCT.md
+
+```

docs/codeofconduct.md

@@ -1,5 +1,7 @@
 ```{include} ../CONTRIBUTING.md
-   :end-before: <!-- github-only -->
+---
+end-before: <!-- github-only -->
+---
 ```
 
 [code of conduct]: codeofconduct

docs/codeofconduct.rst

@@ -0,0 +1,83 @@
+# Hypermodern Python Cookiecutter
+
+```{toctree}
+---
+hidden: true
+maxdepth: 1
+---
+
+Quickstart <quickstart>
+guide
+contributing
+Code of Conduct <codeofconduct>
+license
+Changelog <https://github.com/cjolowicz/cookiecutter-hypermodern-python/releases>
+```
+
+```{include} ../README.md
+---
+start-after: <!-- badges-begin -->
+end-before: <!-- badges-end -->
+---
+```
+
+[Cookiecutter] template for a Python package
+based on the [Hypermodern Python] article series.
+
+## Usage
+
+```console
+$ cookiecutter gh:cjolowicz/cookiecutter-hypermodern-python \
+  --checkout="2021.11.26"
+```
+
+## Features
+
+```{include} ../README.md
+---
+start-after: <!-- features-begin -->
+end-before: <!-- features-end -->
+---
+```
+
+## FAQ
+
+### What is this project about?
+
+The mission of this project is to
+enable current best practices
+through modern Python tooling.
+
+### What makes this project different from other Python templates?
+
+This is a general-purpose template for Python libraries and applications.
+
+Our goals are:
+
+- Focus on simplicity and minimalism
+- Promote code quality through automation
+- Provide reliable and repeatable processes
+
+The project template is centered around the following tools:
+
+- [Poetry][1] for packaging and dependency management
+- [Nox][2] for automation of checks and other development tasks
+- [GitHub Actions][3] for continuous integration and delivery
+
+[1]: https://python-poetry.org/
+[2]: https://nox.thea.codes/
+[3]: https://github.com/features/actions
+
+### Why is this Python template called "hypermodern"?
+
+[Hypermodernism] is a school of chess that dates back to more than a century ago.
+If this setup ever goes out of fashion,
+I can pretend it was my secret plan from the start.
+All images on the
+[associated blog][hypermodern python] show
+[past visions][retrofuturism] of the future.
+
+[cookiecutter]: https://github.com/audreyr/cookiecutter
+[hypermodern python]: https://medium.com/@cjolowicz/hypermodern-python-d44485d9d769
+[hypermodernism]: https://en.wikipedia.org/wiki/Hypermodernism_(chess)
+[retrofuturism]: https://en.wikipedia.org/wiki/Retrofuturism