centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Some minor updates to the documentation

Browse Source 
- Added a small section about where to get help
- Updated link to the contributing guide
- Improved some o the code highlighting
This commit is contained in:
Dougal Matthews
2015-04-14 08:30:44 +01:00
parent ee4c648e9b
commit 7ef39aa4e2
4 changed files with 50 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/about/contributing.md
View File

@@ -10,13 +10,21 @@ can be made in a number of ways, a few examples are:
- Documentation improvements
- Bug reports and patch reviews
## Reporting an issue?
Please include as much detail as you can. Let us know your
platform and MkDocs version. If the problem is visual (for
example a theme or design issue) please add a screenshot and if
you get an error please include the the full error and traceback.
## Installing for development
First you'll need to fork and clone the repository. Once you have
a local copy, run the following command. It is recommended that
you do this within a [virtualenv](virtualenv).
```no-highlight
```text
pip install --editable .
```