Commit Graph

197 Commits

Author SHA1 Message Date
Waylan Limberg
7e6962ff79 Enforce markdownlint test. 2016-04-06 15:49:07 -04:00
Waylan Limberg
fe40c9d1cf Updated Documentation Home Page/Tutorial.
* Updated screenshots to reflect the actual pages in the tutorial (fixes #870).
* Added a few new screenshots to demonstrate more features (search).
* Replaced the `initial-config.png` screenshot with a code block.
* Corrected the inconsistant use of "you" and "we" throughout (use "you").
* Added links to various locations in the docs where appropriate.
* General cleanup, formatting, etc.
2016-04-02 19:45:21 -04:00
Dougal Matthews
a59aa7c490 Add a node to the release notes 2016-03-09 09:04:39 +00:00
Dougal Matthews
614de78e9a Add release note for #728 2016-03-03 10:16:08 +00:00
Dougal Matthews
6e44264461 Add release notes for the two recent PRs 2016-03-03 09:39:45 +00:00
Dougal Matthews
1c252ba4bb Convert context to JSON when it is being passed to JavaScript
Fixes #850
2016-03-02 08:19:35 +00:00
Dougal Matthews
cc1c9a3adb Remove external themes from MkDocs
This change removes the dependency on mkdocs-bootstrap and mkdocs-bootswatch.
It also updates all references in the code. The only remaining connection is
when a user specifies one of these themes but they are not installed they get
slightly helpful error.
2016-03-01 10:53:02 +00:00
lesleyauk
99d118f15f Fix "bootstrap" -> "bootswatch"
Also improved readability.
2016-02-26 18:30:19 +00:00
Dougal Matthews
6ba0ae372c Add a mention to the release notes for the style change
see #718
2016-02-25 08:01:47 +00:00
Dougal Matthews
16f446e906 Fix issues with unicode filenames on Windows and Python 2.
To resolve this error, we need to explicitly encode the string
before we call pathname2url.

Closes #833
2016-02-24 08:01:46 +00:00
Dougal Matthews
59d6c26ec9 Tweak the release notes 2016-02-23 20:06:03 +00:00
Dougal Matthews
b30f38fe29 Merge pull request #832 from pfultz2/master
Add flag to add theme_dir from command line
2016-02-23 19:25:40 +00:00
Paul
c125985af9 Added a release note about the new flag 2016-02-23 12:09:48 -06:00
Dougal Matthews
c868e74ce1 Update index.md 2016-02-19 21:14:02 +00:00
Dougal Matthews
f7525626b8 Remove training whitespace 2016-02-19 21:10:02 +00:00
Brian J King
394f1d3ff2 Updating index.md to fix markdown lint error for line length
https://travis-ci.org/mkdocs/mkdocs/jobs/110445743#L196
2016-02-19 14:35:18 -06:00
Brian J King
9c150c579c Proposed changes to index.md related to mkdocs #818 & #824
Proposed changes to index.md related to mkdocs #818 & #824
2016-02-19 12:13:12 -06:00
Dougal Matthews
2df8d5ece8 Update release-notes.md 2016-02-18 22:10:03 +00:00
Dougal Matthews
34bb1c4567 Prepare to roll a release 2016-02-18 21:35:45 +00:00
Dougal Matthews
6619010702 Handle relative paths in symlinks
Fixes #639
2016-02-18 21:34:50 +00:00
Dougal Matthews
d0139ccb49 Update release notes 2016-02-09 10:38:25 +00:00
Dougal Matthews
8c020f83b9 Update the example version 2016-02-08 09:16:26 +00:00
Dougal Matthews
09253e9cac Bump version to 0.15.2 2016-02-08 09:08:31 +00:00
Dougal Matthews
e904b103ed Add note to release notes 2016-02-05 12:23:47 +00:00
Prayag Verma
cc1f81e9de Minor typo
Remove extra `the`
2016-02-01 01:52:19 +05:30
Dougal Matthews
8a37ba8296 Update release notes 2016-01-30 08:27:52 +00:00
Dougal Matthews
a59ade70ec Bump version to 0.15.0 2016-01-21 09:48:48 +00:00
Waylan Limberg
ffbad6685b Update release notes 2016-01-14 20:22:04 -05:00
daurnimator
e91104f8a6 docs/index.md: doc_dir default is "docs" not "doc" 2016-01-08 13:31:11 +11:00
Waylan Limberg
0aa6e56536 Document the --help flag.
As of 40dc17e17e, any mention of the `--help` flag had been removed from
the documentation. A breif summary has been added here. However, the output
of `--help` has not been included as that can change in the future and
updating the docs every time a option is updated become unnesecarily
duplicative (as the command line is self-documenting). This fixes #767.
2015-11-30 17:31:40 -05:00
Waylan Limberg
c84cb0ce03 More docs cleanup for Markdown linter 2015-08-13 10:18:35 -04:00
Waylan Limberg
bd33c4b76b Corrected lint errors in Markdown docs.
Also added README.md and CONTRIBUTING.md to the linter.

Note, that I am still getting one failer (in two locations). However
I consider that failer a bug in the linter and have reported it
upstream. We could disable that Rule (MD031), but as we are not
requiring the lint rules to pass presently, I just left it alone.

Also, while the code linter is set to allow lines 119 chars long,
I am using the Markdown linter's default of 80. Prose is easier to
read with shorter line lenghts, so I think it makes more sense to
use the default. Also, changing the default would have required
adding a config file. Adding a Ruby file for only one minor setting
seems silly, so I left it alone.
2015-08-13 10:18:34 -04:00
Bruno Oliveira
ab89b36f54 minor typo: filies -> files 2015-08-06 22:42:40 -03:00
Dougal Matthews
567bee1cbf Add a note about including HTML files again 2015-07-25 15:08:02 +01:00
Dougal Matthews
a28dff0bcc Add the Page ancestors fix to the release notes 2015-07-25 15:02:05 +01:00
Dougal Matthews
fdce51d070 Add a note to the release notes for the TOC fix 2015-07-25 14:51:21 +01:00
Dougal Matthews
0c465a81d0 Change the deadline for Python 2.6 Removal
I was being a bit over eager.
2015-07-01 20:58:42 +01:00
Dougal Matthews
857ef4b3cf Start the deprecation of Python 2.6 support
See #165
2015-06-28 22:11:29 +01:00
Dougal Matthews
3c13f2a70f Add examples demonstrating the extra config options 2015-06-28 10:27:01 +01:00
Dougal Matthews
43c64ab766 Add a comment about using the mkdocs-basic theme 2015-06-27 23:05:20 +01:00
Dougal Matthews
463075c5da Remove an outdated remark in the documentation 2015-06-27 23:04:58 +01:00
Dougal Matthews
764b24be22 Added theme packaging to the release notes 2015-06-27 11:03:43 +01:00
Dougal Matthews
44fc6d9230 Added docuementation for packaging themes 2015-06-27 11:03:30 +01:00
Waylan Limberg
9a667c5337 Ensure consistent ordering of auto-populated pages.
Both files and directories should be sorted to ensure consistent ordering of
pages in the menus across builds and systems. Turns out to be a simple fix.
As `os.walk` provides a reference to the list of dirs it uses internally,
we can modify that list in place and it will use the modified list.

While this may not give proper alphanumeric ordering for all languages,
it goes ensure consistent ordering. For more control over ordering,
it is expected that a plugin could be used once that API becomes available.

Fixes #638.
2015-06-26 20:04:58 -04:00
RussellTaylor83
40dc17e17e Update index.md
Updated documentation, mkdocs help is no longer valid, suggested mkdocs --version instead.
2015-06-23 21:43:10 +01:00
Dougal Matthews
e16f9384ea Add site_author and site_description to the ReadTheDocs theme
Fixes #631
2015-06-16 09:24:26 +01:00
Harri Berglund
b33f6e6d64 Update deploying-your-docs.md
Fix some typos.

[ci skip]
2015-06-15 22:09:09 +03:00
Dougal Matthews
7e9cdc7955 Added release notes for 48c0752 2015-06-12 15:59:23 +01:00
Dougal Matthews
3f89332156 Link to the Markdown, not the built output location
This means the links will work in GitHub etc.
2015-06-11 09:59:56 +01:00
Dougal Matthews
d4e87c3b6a Bump version 2015-06-09 10:07:48 +01:00