Skip to content

Commit

Permalink
Merge pull request #698 from waylan/lint
Browse files Browse the repository at this point in the history
Corrected lint errors in Markdown docs.
  • Loading branch information
d0ugal committed Aug 15, 2015
2 parents 2cd95d4 + c84cb0c commit d7930bd
Show file tree
Hide file tree
Showing 11 changed files with 363 additions and 234 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
See the contributing guide in the documentation for an
introduction to contributing to MkDocs.

http://www.mkdocs.org/about/contributing/
<http://www.mkdocs.org/about/contributing/>
4 changes: 1 addition & 3 deletions docs/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,13 @@ ways, a few examples are:
- Documentation improvements
- Bug reports and patch reviews

## Reporting an Issue?
## 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.


## Testing the Development Version

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


## Running the tests

To run the tests, it is recommended that you use [Tox]. This just needs
Expand Down
31 changes: 23 additions & 8 deletions docs/about/license.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ The legal stuff.

---

#### Included projects
## Included projects

Themes used under license from the Bootstrap, ReadTheDocs, GhostWriter and Bootswatch projects.
Themes used under license from the Bootstrap, ReadTheDocs, GhostWriter and
Bootswatch projects.

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

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

#### MkDocs License (BSD)
## MkDocs License (BSD)

Copyright © 2014, Tom Christie. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

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.

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.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

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.

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.
26 changes: 9 additions & 17 deletions docs/about/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@ You can determine your currently installed version using `mkdocs --version`:
$ mkdocs --version
mkdocs, version 0.14.0


## Version 0.15.0 (2015-??-??)

### Major Additions
### Major Additions to Version 0.15.0

#### Add support for installable themes

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

- [MkDocs Bootstrap]
- [MkDocs Bootswatch]
* [MkDocs Bootstrap]
* [MkDocs Bootswatch]

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

### Other Changes and Additions
### Other Changes and Additions to Version 0.15.0

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


## Version 0.13.0 (2015-05-26)

### Deprecations
### Deprecations to Version 0.13.0

#### Deprecate the JSON command

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


### Major Additions
### Major Additions to Version 0.13.0

#### Search

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

### Other Changes and Additions
### Other Changes and Additions to Version 0.13.0

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

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


## Version 0.12.2 (2015-04-22)

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


## Version 0.12.1 (2015-04-14)

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


## Version 0.12.0 (2015-04-14)

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


## Version 0.11.1 (2014-11-20)

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


## Version 0.11.0 (2014-11-18)

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


## Version 0.10.0 (2014-10-29)

* Added support for Python 3.3 and 3.4. (#103)
Expand Down
Loading

0 comments on commit d7930bd

Please sign in to comment.