Skip to content

Commit d7930bd

Browse files
committed
Merge pull request mkdocs#698 from waylan/lint
Corrected lint errors in Markdown docs.
2 parents 2cd95d4 + c84cb0c commit d7930bd

File tree

11 files changed

+363
-234
lines changed

11 files changed

+363
-234
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
See the contributing guide in the documentation for an
44
introduction to contributing to MkDocs.
55

6-
http://www.mkdocs.org/about/contributing/
6+
<http://www.mkdocs.org/about/contributing/>

docs/about/contributing.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,13 @@ ways, a few examples are:
1010
- Documentation improvements
1111
- Bug reports and patch reviews
1212

13-
## Reporting an Issue?
13+
## Reporting an Issue
1414

1515
Please include as much detail as you can. Let us know your platform and MkDocs
1616
version. If the problem is visual (for example a theme or design issue) please
1717
add a screenshot and if you get an error please include the the full error and
1818
traceback.
1919

20-
2120
## Testing the Development Version
2221

2322
If you want to just install and try out the latest development version of
@@ -43,7 +42,6 @@ pip install --editable .
4342
This will install MkDocs in development mode which binds the `mkdocs` command
4443
to the git repository.
4544

46-
4745
## Running the tests
4846

4947
To run the tests, it is recommended that you use [Tox]. This just needs

docs/about/license.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ The legal stuff.
44

55
---
66

7-
#### Included projects
7+
## Included projects
88

9-
Themes used under license from the Bootstrap, ReadTheDocs, GhostWriter and Bootswatch projects.
9+
Themes used under license from the Bootstrap, ReadTheDocs, GhostWriter and
10+
Bootswatch projects.
1011

1112
* Bootstrap theme - [View license](//github.com/twbs/bootstrap/blob/master/LICENSE).
1213
* ReadTheDocs theme - [View license](//github.com/snide/sphinx_rtd_theme/blob/master/LICENSE).
@@ -15,12 +16,26 @@ Themes used under license from the Bootstrap, ReadTheDocs, GhostWriter and Boots
1516

1617
Many thanks to the authors and contributors of those wonderful projects.
1718

18-
#### MkDocs License (BSD)
19+
## MkDocs License (BSD)
1920

2021
Copyright © 2014, Tom Christie. All rights reserved.
2122

22-
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
23-
24-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
25-
26-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23+
Redistribution and use in source and binary forms, with or without modification,
24+
are permitted provided that the following conditions are met:
25+
26+
Redistributions of source code must retain the above copyright notice, this list
27+
of conditions and the following disclaimer. Redistributions in binary form must
28+
reproduce the above copyright notice, this list of conditions and the following
29+
disclaimer in the documentation and/or other materials provided with the
30+
distribution.
31+
32+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
33+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
34+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
35+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
36+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
37+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
39+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
41+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

docs/about/release-notes.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,9 @@ You can determine your currently installed version using `mkdocs --version`:
1313
$ mkdocs --version
1414
mkdocs, version 0.14.0
1515

16-
1716
## Version 0.15.0 (2015-??-??)
1817

19-
### Major Additions
18+
### Major Additions to Version 0.15.0
2019

2120
#### Add support for installable themes
2221

@@ -25,8 +24,8 @@ addition, the Bootstrap and Bootswatch themes have been moved to external git
2524
repositories and python packages. See their individual documentation for more
2625
details about these specific themes.
2726

28-
- [MkDocs Bootstrap]
29-
- [MkDocs Bootswatch]
27+
* [MkDocs Bootstrap]
28+
* [MkDocs Bootswatch]
3029

3130
[MkDocs Bootstrap]: http://mkdocs.github.io/mkdocs-bootstrap/
3231
[MkDocs Bootswatch]: http://mkdocs.github.io/mkdocs-bootswatch/
@@ -42,7 +41,7 @@ themes
4241
[Styling your docs]: /user-guide/styling-your-docs.md
4342
[Custom themes]: /user-guide/custom-themes.md
4443

45-
### Other Changes and Additions
44+
### Other Changes and Additions to Version 0.15.0
4645

4746
* Fix issues when using absolute links to Markdown files. (#628)
4847
* Deprecate support of Python 2.6, pending removal in 1.0.0. (#165)
@@ -94,10 +93,9 @@ themes
9493
* Bugfix: Fix a problem with minimal configurations which only contain a list
9594
of paths in the pages config. (#562)
9695

97-
9896
## Version 0.13.0 (2015-05-26)
9997

100-
### Deprecations
98+
### Deprecations to Version 0.13.0
10199

102100
#### Deprecate the JSON command
103101

@@ -133,8 +131,7 @@ All themes other than mkdocs and readthedocs will be moved into external
133131
packages in a future release of MkDocs. This will enable them to be more easily
134132
supported and updates outside MkDocs releases.
135133

136-
137-
### Major Additions
134+
### Major Additions to Version 0.13.0
138135

139136
#### Search
140137

@@ -177,7 +174,7 @@ documentation.
177174
[extra_templates]: /user-guide/configuration.md#extra_templates
178175
[global variables]: /user-guide/styling-your-docs.md#global-context
179176

180-
### Other Changes and Additions
177+
### Other Changes and Additions to Version 0.13.0
181178

182179
* Add support for [Markdown extension configuration options]. (#435)
183180
* MkDocs now ships Python [wheels]. (#486)
@@ -188,26 +185,24 @@ documentation.
188185
* Add `--no-livereload` to `mkdocs serve` for a simpler development server. (#511)
189186
* Add copyright display support to all themes (#549)
190187
* Add support for custom commit messages in a `mkdocs gh-deploy` (#516)
191-
* Bugfix: Fix linking to media within the same directory as a markdown file called index.md (#535)
188+
* Bugfix: Fix linking to media within the same directory as a markdown file
189+
called index.md (#535)
192190
* Bugfix: Fix errors with unicode filenames (#542).
193191

194192
[extra config]: /user-guide/configuration.md#extra
195193
[Markdown extension configuration options]: /user-guide/configuration.md#markdown_extensions
196194
[wheels]: http://pythonwheels.com/
197195

198-
199196
## Version 0.12.2 (2015-04-22)
200197

201198
* Bugfix: Fix a regression where there would be an error if some child titles
202199
were missing but others were provided in the pages config. (#464)
203200

204-
205201
## Version 0.12.1 (2015-04-14)
206202

207203
* Bugfix: Fixed a CSS bug in the table of contents on some browsers where the
208204
bottom item was not clickable.
209205

210-
211206
## Version 0.12.0 (2015-04-14)
212207

213208
* Display the current MkDocs version in the CLI output. (#258)
@@ -263,13 +258,11 @@ documentation.
263258
* Bugfix: Don't block newer verions of Python-markdown on Python >= 2.7. (#376)
264259
* Bugfix: Fix encoding issues when opening files across platforms. (#428)
265260

266-
267261
## Version 0.11.1 (2014-11-20)
268262

269263
* Bugfix: Fix a CSS wrapping issue with code highlighting in the ReadTheDocs
270264
theme. (#233)
271265

272-
273266
## Version 0.11.0 (2014-11-18)
274267

275268
* Render 404.html files if they exist for the current theme. (#194)
@@ -285,7 +278,6 @@ documentation.
285278
filesystems without inotify. (#184)
286279
* Bugfix: Improve error output for common configuration related errors. (#176)
287280

288-
289281
## Version 0.10.0 (2014-10-29)
290282

291283
* Added support for Python 3.3 and 3.4. (#103)

0 commit comments

Comments
 (0)