OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2020-08-12 09:12:11 +02:00
parent 200cd6d8e3
commit 12519a2411
2 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,5 +1,5 @@
<p align="center">
<a href="https://squidfunk.github.io/mkdocs-material">
<a href="https://squidfunk.github.io/mkdocs-material/">
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.png" width="320" alt="Material for MkDocs">
</a>
</p>
@ -18,10 +18,10 @@
src="https://github.com/squidfunk/mkdocs-material/workflows/ci/badge.svg?branch=master"
alt="GitHub Action"
/></a>
<a href="https://pypistats.org/packages/mkdocs-material"><img
<!--<a href="https://pypistats.org/packages/mkdocs-material"><img
src="https://img.shields.io/pypi/dm/mkdocs-material.svg"
alt="Downloads"
/></a>
/></a>-->
<a href="https://gitter.im/squidfunk/mkdocs-material"><img
src="https://badges.gitter.im/squidfunk/mkdocs-material.svg"
alt="Chat on Gitter"
@ -34,8 +34,8 @@
src="https://img.shields.io/docker/pulls/squidfunk/mkdocs-material"
alt="Docker Pulls"
/></a>
<a href="https://github.com/sponsors/squidfunk"><img
src="https://img.shields.io/static/v1?label=sponsor&message=%E2%9D%A4&logo=GitHub&color=ea4aaa"
<a href="https://squidfunk.github.io/mkdocs-material/insiders/"><img
src="https://img.shields.io/static/v1?label=%E2%86%92&message=insiders&color=e91e63"
/></a>
</p>
@ -97,6 +97,15 @@
with TypeScript, RxJS, and SCSS, and is compiled with Webpack, bringing
excellent possibilities for theme extension and customization.
_Material for MkDocs uses the [sponsorware][2] release strategy, which means
that new features are first exclusively released to sponsors as part of Material
for MkDocs Insiders. Read on to learn [how sponsorship works][3], and how you
can [become a sponsor][4]._
[2]: https://github.com/sponsorware/docs
[3]: https://squidfunk.github.io/mkdocs-material/insiders/#how-sponsorship-works
[4]: https://squidfunk.github.io/mkdocs-material/insiders/#how-to-become-a-sponsor
## Quick start
Material for MkDocs can be installed with `pip`:
@ -117,6 +126,14 @@ For other installation methods, configuration options, and a demo, visit
[1]: https://squidfunk.github.io/mkdocs-material/
## Sponsors
<p>
<a href="https://cirrus-ci.org/" target=_blank>
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/cirrus-ci.svg" width="155" />
</a>
</p>
## Users
* **Companies** —
@ -145,20 +162,6 @@ For other installation methods, configuration options, and a demo, visit
[Vapor](https://docs.vapor.codes/),
[ZeroNet](https://zeronet.io/docs/)
## Sponsors
<p>
<a href="https://cirrus-ci.org/" target=_blank>
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/cirrus-ci.svg" width="155" />
</a>
</p>
If you're using this project a lot, consider [sponsoring][2] it! This will give
me the opportunity to sustain my efforts maintaining it. Every contribution
counts, no matter how small!
[2]: https://github.com/sponsors/squidfunk
## License
**MIT License**

2
docs/insiders.md
View File

@ -45,7 +45,7 @@ away from enjoying the latest features of Material for MkDocs Insiders.
Complete the following steps and you're in:
- Visit [squidfunk's sponsor profile][6] and pick a tier that includes exclusive
access to squidfunk's sponsorware, which is _any tier above $10/month_. Select
access to squidfunk's sponsorware, which is _any tier from $10/month_. Select
the tier and complete the checkout.
- Within 24 hours, you will become a collaborator of the private Material for
MkDocs Insiders GitHub repository, a fork of Material for MkDocs with