diff --git a/docs/develop/contributing.md b/docs/develop/contributing.md index f06af930..5575046f 100644 --- a/docs/develop/contributing.md +++ b/docs/develop/contributing.md @@ -1,5 +1,11 @@ # Contributing +[![CI Status][travis-badge]][travis-link] +[![Coverage][coveralls-badge]][coveralls-link] +[![CircleCI][circleci-badge]][circleci-link] +[![Documentation Status][rtd-badge]][rtd-link] +[![Code style: black][black-badge]][black-link] + ## Code Style Code style is tested using [flake8](http://flake8.pycqa.org), @@ -63,3 +69,14 @@ Merging pull requests: There are three ways of 'merging' pull requests on GitHub Examples: PRs that contain multiple commits with individually significant changes; PRs that have commits from different authors (squashing commits would remove attribution) - Merge with merge commit: put all commits as they are on the base branch, with a merge commit on top Choose for collaborative PRs with many commits. Here, the merge commit provides actual benefits. + +[travis-badge]: https://travis-ci.org/ExecutableBookProject/MyST-Parser.svg?branch=master +[travis-link]: https://travis-ci.org/ExecutableBookProject/MyST-Parser +[coveralls-badge]: https://coveralls.io/repos/github/ExecutableBookProject/MyST-Parser/badge.svg?branch=master +[coveralls-link]: https://coveralls.io/github/ExecutableBookProject/MyST-Parser?branch=master +[circleci-badge]: https://circleci.com/gh/ExecutableBookProject/MyST-Parser.svg?style=shield +[circleci-link]: https://circleci.com/gh/ExecutableBookProject/MyST-Parser +[rtd-badge]: https://readthedocs.org/projects/myst-parser/badge/?version=latest +[rtd-link]: https://myst-parser.readthedocs.io/en/latest/?badge=latest +[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg +[black-link]: https://github.com/ambv/black diff --git a/docs/using/install.md b/docs/using/install.md index 89f56119..c19c4f2c 100644 --- a/docs/using/install.md +++ b/docs/using/install.md @@ -1,5 +1,8 @@ # Installing the MyST Parser +[![PyPI][pypi-badge]][pypi-link] +[![Conda][conda-badge]][conda-link] + Installing the MyST parser provides access to two tools: * A MyST-to-docutils parser and renderer. @@ -26,3 +29,8 @@ cd MyST-Parser git checkout master pip install -e .[sphinx,code_style,testing,rtd] ``` + +[pypi-badge]: https://img.shields.io/pypi/v/myst-parser.svg +[pypi-link]: https://pypi.org/project/myst-parser +[conda-badge]: https://anaconda.org/conda-forge/myst-parser/badges/version.svg +[conda-link]: https://anaconda.org/conda-forge/myst-parser