mkdocs

Project documentation with Markdown.

https://github.com/mkdocs/mkdocs

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
○
.zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
3 of 258 committers (1.2%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.4%) to scientific vocabulary

Keywords

documentation markdown mkdocs python static-site-generator

Keywords from Contributors

templates apps views closember distributed json-schema unit-testing syntax-highlighting asgi notebook

Last synced: 6 months ago · JSON representation

Repository

Project documentation with Markdown.

Basic Info

Host: GitHub
Owner: mkdocs
License: bsd-2-clause
Language: Python
Default Branch: master
Homepage: https://www.mkdocs.org
Size: 31.7 MB

Statistics

Stars: 20,971
Watchers: 233
Forks: 2,534
Open Issues: 121
Releases: 15

Topics

documentation markdown mkdocs python static-site-generator

Created about 12 years ago · Last pushed 7 months ago

Metadata Files

Readme Contributing Funding License

MkDocs

Project documentation with Markdown

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 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 built-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!

For questions and high-level discussions, use Discussions on GitHub.
- For small questions, a good alternative is the Chat room on Gitter/Matrix.
To report a bug or make a feature request, open an Issue on GitHub.

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.
But, such questions are not banned from the chat room.

Make sure to stick around to answer some questions as well!

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, and discussion forums is expected to follow the PyPA Code of Conduct.

License

BSD-2-Clause

Owner

Name: MkDocs
Login: mkdocs
Kind: organization

Website: http://www.mkdocs.org/
Repositories: 15
Profile: https://github.com/mkdocs

Project documentation with Markdown

GitHub Events

Total

Issues event: 94
Watch event: 1,625
Member event: 2
Issue comment event: 237
Push event: 2
Pull request review event: 24
Pull request review comment event: 16
Pull request event: 39
Gollum event: 27
Fork event: 157

Last Year

Issues event: 94
Watch event: 1,625
Member event: 2
Issue comment event: 237
Push event: 2
Pull request review event: 24
Pull request review comment event: 16
Pull request event: 39
Gollum event: 27
Fork event: 157

Committers

Last synced: 6 months ago

All Time

Total Commits: 1,702
Total Committers: 258
Avg Commits per committer: 6.597
Development Distribution Score (DDS): 0.767

Past Year

Commits: 48
Committers: 18
Avg Commits per committer: 2.667
Development Distribution Score (DDS): 0.688

Top Committers

Name	Email	Commits
Dougal Matthews	d**l@r**m	396
Oleh Prypin	o**h@p**n	386
Waylan Limberg	w**g@i**m	255
Tom Christie	t**m@t**m	131
Álvaro Mondéjar	m**4@g**m	25
Christian Oliff	c**f@y**m	16
Michael Diodone	m**e@d**m	15
Ng Zhi An	n**n@g**m	15
Eric Holscher	e**c@e**m	15
Martin Donath	m**h@s**m	13
Ultrabug	u****g	13
sloria	s**1@g**m	12
Jim Porter	i**r@g**m	12
Mikael Hernrup	m**l@h**e	12
Frank Sachsenheim	f**e@r**t	11
Timothée Mazzucotelli	p**y@p**e	8
Chomba Ng'ang'a	c**a@g**m	7
Sam Hatfield	s**d@l**k	7
Yeray Diaz Diaz	y**z@g**m	6
Dmitry Shachnev	m**7@g**m	6
Zenon Mousmoulas	z**m@n**r	6
Adrian Sampson	a**n@r**g	6
alcesleo	l**n@g**m	6
Jim Porter	j**r@m**m	5
Terrell Russell	t**l@g**m	5
Ugo Cupcic	u**o@s**m	5
kaiix	k**u@g**m	5
Castro	c**o@c**r	4
Ezequiel Bertti	e**i@g**m	4
Steven	s**n@c**m	4
and 228 more...

Committer Domains (Top 20 + Academic)

bloomberg.net: 1 peterdavehello.org: 1 lukasgeiter.com: 1 telemidia.puc-rio.br: 1 intechinfo.fr: 1 ranvier.net: 1 yahoo.de: 1 vandenieuwenhof.nl: 1 jtolar.net: 1 accentgrave.net: 1 arcor.de: 1 twardoch.com: 1 allisonthackston.com: 1 rainforce.org: 1 hardchee.se: 1 hrbac.cz: 1 matthewmcmillan.me: 1 philoxenic.com: 1 laposte.net: 1 baeck.at: 1 asu.edu: 1 inl.gov: 1 lipscomb.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 476
Total pull requests: 318
Average time to close issues: about 1 year
Average time to close pull requests: about 2 months
Total issue authors: 391
Total pull request authors: 117
Average comments per issue: 3.87
Average comments per pull request: 2.03
Merged pull requests: 152
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 86
Pull requests: 49
Average time to close issues: about 23 hours
Average time to close pull requests: about 13 hours
Issue authors: 83
Pull request authors: 25
Average comments per issue: 0.91
Average comments per pull request: 1.16
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

pawamoy (10)
waylan (8)
squidfunk (7)
vixinadg (7)
Andre601 (6)
d0ugal (6)
ghost (6)
fralau (5)
tomchristie (5)
redtide (4)
oprypin (4)
osresearch (3)
daviewales (3)
jimporter (3)
Skrillx13 (2)

Pull Request Authors

oprypin (102)
squidfunk (18)
tomchristie (15)
ultrabug (7)
waylan (6)
pawamoy (4)
janbrasna (4)
Aniket28ks (4)
dhanush2k3 (3)
Asantosjorge (2)
mschoettle (2)
segevfiner (2)
thecodinman (2)
habored (2)
theacodes (2)

Top Labels

Issue Labels

Enhancement (40) Needs design decision (18) Documentation (18) Theme-mkdocs (12) CLI (10) Process (8) Plugins (8) Search (8) Bug (7) Theme-readthedocs (6) Theme-general (6) Command - serve (4) Titles (4) Navigation (4) Idea (4) Cleanup (3) Configuration (3) Validation (3) Performance (2) Easy (2) Logging (2) Needs confirmation (2) Needs further review (2) Needs information (2) Plugin (2) Priority (1) Table of contents (1) Command - deploy (1) Contributions welcome (1)

Pull Request Labels

Cleanup (7) Docs (4) Release (2) Needs design decision (1) Bug (1)

Packages

Total packages: 3
Total downloads:
- pypi 8,536,639 last-month
Total docker downloads: 12,997,161

Total dependent packages: 1,494
(may contain duplicates)
Total dependent repositories: 18,004
(may contain duplicates)
Total versions: 64
Total maintainers: 6
Total advisories: 1

pypi.org: mkdocs

Project documentation with Markdown.

Documentation: https://www.mkdocs.org/
License: BSD License
Latest release: 1.6.1
published over 1 year ago

Versions: 62
Dependent Packages: 1,494
Dependent Repositories: 18,004
Downloads: 8,536,483 Last month
Docker Downloads: 12,997,161

Rankings

Dependent packages count: 0.0%

Dependent repos count: 0.1%

Stargazers count: 0.1%

Downloads: 0.2%

Average: 0.2%

Forks count: 0.3%

Docker downloads count: 0.7%

Maintainers (5)

tomchristie d0ugal waylan mkdocsdeploy oprypin

Advisories (1)

Directory traversal in mkdocs

Last synced: 6 months ago

pypi.org: mkdocs-zh

Project documentation with Markdown.

Documentation: https://www.mkdocs.org/
License: BSD License
Latest release: 1.4.2b1
published about 3 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 15 Last month

Rankings

Stargazers count: 0.1%

Forks count: 0.3%

Dependent packages count: 6.6%

Average: 15.0%

Dependent repos count: 30.6%

Downloads: 37.3%

Maintainers (1)

qinyn

Last synced: 6 months ago

pypi.org: hutb-doc

Project documentation with Markdown.

Documentation: https://www.mkdocs.org/
License: BSD License
Latest release: 1.5.3
published 6 months ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 141 Last month

Rankings

Dependent packages count: 8.6%

Average: 28.6%

Dependent repos count: 48.6%

Last synced: 6 months ago

Dependencies

.github/workflows/ci.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/setup-python v4 composite
codecov/codecov-action v3 composite

.github/workflows/deploy-release.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

pyproject.toml pypi

Jinja2 >=2.11.1
Markdown >=3.2.1
PyYAML >=5.1
click >=7.0
colorama >=0.4; platform_system == 'Windows'
ghp-import >=1.0
importlib-metadata >=4.3; python_version < '3.10'
markupsafe >=2.0.1
mergedeep >=1.3.4
packaging >=20.5
pathspec >=0.11.1
platformdirs >=2.2.0
pyyaml_env_tag >=0.1
typing-extensions >=3.10; python_version < '3.8'
watchdog >=2.0

setup.py pypi

.github/workflows/docs.yml actions

actions/checkout v4 composite
actions/setup-python v4 composite

requirements/requirements-docs.txt pypi

click ==8.1.7
colorama ==0.4.6
ghp-import ==2.1.0
griffe ==0.38.0
jinja2 ==3.1.2
markdown ==3.5.1
markdown-callouts ==0.3.0
markupsafe ==2.1.3
mdx-gh-links ==0.3.1
mergedeep ==1.3.4
mkdocs ==1.5.3
mkdocs-autorefs ==0.5.0
mkdocs-click ==0.8.1
mkdocs-get-deps ==0.2.0
mkdocs-literate-nav ==0.6.1
mkdocs-redirects ==1.2.1
mkdocstrings ==0.24.0
mkdocstrings-python ==1.7.5
packaging ==23.2
pathspec ==0.11.2
platformdirs ==4.0.0
pymdown-extensions ==10.4
python-dateutil ==2.8.2
pyyaml ==6.0.1
pyyaml-env-tag ==0.1
six ==1.16.0
watchdog ==3.0.0

mkdocs

Science Score: 23.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

MkDocs

Features

Support

Links

Contributing to MkDocs

Code of Conduct

License

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: mkdocs

Rankings

Maintainers (5)

Advisories (1)

pypi.org: mkdocs-zh

Rankings

Maintainers (1)

pypi.org: hutb-doc

Rankings

Dependencies