Refactor Readme and use for long_description

Improve readme with a different structure and some link changes.

The landscape.io links have been removed as that project seems 
discontinued since April 2020.

With `long_description_content_type="text/markdown"` it is possible
to use Markdown text in the `long_description` meta-data field. Make sure
the latest tools (setuptools, wheel, twine) are installed before deploying.
This commit is contained in:
Andre_601
2021-03-29 16:22:44 +02:00
committed by GitHub
parent 41c9961de5
commit fd5a890578
2 changed files with 50 additions and 21 deletions

View File

@@ -1,35 +1,67 @@
# MkDocs
Project documentation with Markdown.
---
> *Project documentation with Markdown*
[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Build Status][GHAction-image]][GHAction-link]
[![Coverage Status][codecov-image]][codecov-link]
[![Landscale Code Health][landscape-image]][landscape-link]
- View the [MkDocs documentation][mkdocs].
- Project [release notes][release-notes].
- Visit the [MkDocs wiki](https://github.com/mkdocs/mkdocs/wiki) for community
resources, including third party themes and a list of MkDocs users.
- Discussions and support: <https://github.com/mkdocs/mkdocs/discussions>
MkDocs is a **fast**, **simple** and **downright gorgeous** static site
generator that's geared towards building project documentation. Documentation
source files are written in Markdown, and configured with a single YAML
configuration file. It is designed to be easy to use and can be extended with
third-party themes, plugins, and Markdown extensions.
Please see the [Documentation][mkdocs] for an introductory tutorial and a full
user guide.
## Features
- Build static HTML files from Markdown files.
- Use Plugins and Markdown Extensions to enhance MkDocs.
- Use the build-in themes, third party themes or create your own.
- Publish your documentation anywhere that static files can be served.
- Much more!
## Support
If you need help with MkDocs, do not hesitate to get in contact with us!
You can either open a [Discussion] to ask questions or create an [Issue] to
report a bug or make a feature request. Please note that we may only provide
support for problems/questions regarding core features of MkDocs. Any
questions or bug reports about features of third-party themes, plugins,
extensions or similar should be made to their respective projects.
## Links
- [Official Documentation][mkdocs]
- [Latest Release Notes][release-notes]
- [MkDocs Wiki][wiki] (Third-party themes, recipes, plugins and more)
## Contributing to MkDocs
The MkDocs project welcomes, and depends on, contributions from developers and
users in the open source community. Please see the [Contributing Guide] for
information on how you can help.
## Code of Conduct
Everyone interacting in the MkDocs project's codebases, issue trackers, chat
rooms, and mailing lists is expected to follow the [PyPA Code of Conduct].
Everyone interacting in the MkDocs project's codebases, issue trackers, and
discussion forums is expected to follow the [PyPA Code of Conduct].
<!-- Badges -->
[codecov-image]: https://codecov.io/github/mkdocs/mkdocs/coverage.svg?branch=master
[codecov-link]: https://codecov.io/github/mkdocs/mkdocs?branch=master
[landscape-image]: https://landscape.io/github/mkdocs/mkdocs/master/landscape.svg?style=flat
[landscape-link]: https://landscape.io/github/mkdocs/mkdocs/master
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs.svg
[pypi-v-link]: https://pypi.org/project/mkdocs/
[GHAction-image]: https://github.com/mkdocs/mkdocs/workflows/CI/badge.svg?branch=master&event=push
[GHAction-link]: https://github.com/mkdocs/mkdocs/actions?query=event%3Apush+branch%3Amaster
<!-- Links -->
[mkdocs]: https://www.mkdocs.org
[Issue]: https://github.com/mkdocs/mkdocs/issues
[Discussion]: https://github.com/mkdocs/mkdocs/discussions
[release-notes]: https://www.mkdocs.org/about/release-notes/
[wiki]: https://github.com/mkdocs/mkdocs/wiki
[Contributing Guide]: https://www.mkdocs.org/about/contributing/
[PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/