Commit Graph

175 Commits

Author SHA1 Message Date
squidfunk
0d79026c0c Reworked getting started guide 2020-03-09 16:48:52 +01:00
squidfunk
41dc846753 Merge branch 'master' into refactor/rxjs-typescript 2020-02-10 12:34:58 +01:00
Martin B
c44ea77172 Separated plugin documentation from extensions ()
* Create minify-html.md

* Rename docs/minify-html.md to docs/plugins/minify-html.md

* Create search.md

* Update and rename docs/extensions/revision-date.md to docs/plugins/revision-date.md

* Update getting-started.md

* Update mkdocs.yml
2019-12-18 17:13:17 +01:00
Christian Oliff
5960f187d2 Updated FontAwesome URL to correct version ()
The Font Awesome link now correctly links to v4.7 icons (instead of v5)
2019-12-18 08:32:21 +01:00
Christian Oliff
157d1ef5f0 Fixed HTML error on getting started page
The table headings `th` weren't matching.
2019-12-18 08:07:01 +01:00
Tim Vink
6d3d1301e2 Added translation issue template ()
* Update issue templates

Add `translate.md`

* Update link to new translation issue
2019-12-11 17:17:54 +01:00
squidfunk
a98b93299f Merge branch 'master' of github.com:squidfunk/mkdocs-material 2019-12-02 15:50:42 +01:00
squidfunk
51cf93518b Added Thai translations 2019-12-02 15:50:04 +01:00
Christian Oliff
bb4faf3053 Updated minimum versions in Getting Started guide ()
MkDocs Material has required MkDocs v1.x since version 3 so I think it'd be right to update the minimum version here now.
MkDocs v1 was released more than a year ago and older versions are unsupported.
I also bumped the versions of Python and PIP just for good measure as those (although they are just example output) are really old versions too.

(minor nitpicky thing is that the first release of MkDocs v1 release on https://github.com/mkdocs/mkdocs/releases is actually 1.0, but I put it above as 1.0.0 for consistencty... feel free to change :-D
2019-11-29 17:45:15 +01:00
Kristjan Tärk
0826b9243b Added Estonian translations () 2019-10-03 11:14:32 +02:00
squidfunk
af81591cce Prepare 4.4.2 release 2019-08-27 17:41:51 +02:00
squidfunk
6b7535b8cc Added black as a primary color 2019-08-22 16:11:51 +02:00
squidfunk
13c8ad3370 Fixed minification settings and documentation 2019-06-20 10:28:33 +02:00
squidfunk
bc46b87d6a Added documentation on minification 2019-06-15 15:47:53 +02:00
squidfunk
f6e08ef4a3 Added Slovenian translations 2019-06-15 14:26:34 +02:00
squidfunk
611dc9718f Added Norwegian Nynorsk translations 2019-04-28 11:37:56 +02:00
squidfunk
9a16b9c6ea Fixed Asian search after lunr-languages upgrade 2019-03-12 16:33:58 +01:00
squidfunk
74c473e2d7 Added Greek translations 2019-02-13 15:59:56 +01:00
squidfunk
5501462b85 Added better explanation for tabs feature 2019-02-09 17:33:08 +01:00
squidfunk
382797f21c Fixed documentation 2018-11-17 17:57:47 +01:00
Richie Bendall
62927073de Added documentation for Web App Manifest () 2018-11-17 17:51:35 +01:00
squidfunk
fe42b2f7e1 Prepare 3.0.6 release 2018-10-26 13:15:41 +02:00
squidfunk
8217dcd8cd Updated documentation 2018-10-23 09:04:26 +02:00
squidfunk
a534c93e68 Fixed documentation for Serbo-Croatian translations 2018-08-06 09:35:49 +02:00
Martin Donath
013033a9c0
Fixed Travis build
* Debug Travis build

* Try to build as Python project

* Do not install in user space

* Fixed Travis build
2018-08-05 18:38:16 +02:00
squidfunk
fd75fa8eb7 Added Serbian and Serbo-Croatian translations 2018-08-04 20:35:14 +02:00
squidfunk
65cefb835a Added Hindi and Czech translations 2018-06-29 11:14:23 +02:00
squidfunk
7d958b16bb Updated documentation 2018-06-10 18:13:39 +02:00
Ed Morley
ca773de86c Fixed: Changed links to mkdocs.org to HTTPS
To prevent the unnecessary HTTP 301 (and reduce the redirects noise
when running the W3C link checker tool against generated pages).

Also fixes the anchor fragment for `#using-the-theme-custom_dir`.
2018-06-10 15:30:26 +02:00
squidfunk
59a208cc64 Added Finnish translations 2018-04-26 10:38:26 +02:00
squidfunk
ed95c1c52c Prepare 2.7.1 release 2018-03-21 20:26:53 +01:00
squidfunk
65a67b290b Added new language to documentation 2018-03-21 20:14:29 +01:00
squidfunk
e6841b76e9 Prepare 2.7.0 release 2018-03-06 17:59:21 +01:00
squidfunk
75d924d4fa Added Catalan translations 2018-02-21 23:08:20 +01:00
squidfunk
dbd0006b01 Prepare 2.6.3 release 2018-02-18 23:31:58 +01:00
squidfunk
a4be275f88 Added Arabic translations 2018-02-12 21:43:31 +01:00
squidfunk
7cf7ff98a2 Added documentation for Disqus overrides 2018-02-11 20:01:00 +01:00
squidfunk
e55a82b96c Added ability to override Disqus integration using metadata 2018-02-11 20:01:00 +01:00
squidfunk
c1a6591f12 Added Persian to documentation 2018-02-02 00:28:32 +01:00
squidfunk
c002cc2881 Fixed search for languages without stemmers 2018-02-02 00:28:32 +01:00
squidfunk
189d688852 Added Hungarian translations 2018-01-31 18:03:45 +01:00
squidfunk
f87718feca Added call for contributions to landing page 2018-01-25 20:14:06 +01:00
squidfunk
3132cee3dd Added Ukrainian translations 2018-01-25 19:43:59 +01:00
squidfunk
4b5c45c656 Refactored search language handling 2018-01-21 23:02:04 +01:00
squidfunk
0e1850280a Added support for skip-to-content link 2018-01-18 21:33:22 +01:00
squidfunk
b86463757f Prepare 2.5.0 release 2018-01-13 17:24:30 +01:00
Jonas Fonseca
39badcb543 Fix wording in the documentation for primary-only colors 2017-12-09 20:39:42 +01:00
squidfunk
98dfb83d43 Prepare 2.2.2 release 2017-12-08 09:46:16 +01:00
Dmytro Bogatov
4ea70d6630 Fix typo. 2017-12-06 23:12:32 +01:00
squidfunk
d014b21bd5 Prepare 2.2.1 release 2017-12-02 15:01:52 +01:00
squidfunk
57142f144b Prepare 2.1.0 release 2017-11-19 18:02:58 +01:00
squidfunk
250f1fd172 Added white to primary colors 2017-11-19 17:49:37 +01:00
squidfunk
7b1c003536 Fixed search language configuration in getting started guide 2017-11-05 16:16:00 +01:00
squidfunk
1c11a78f44 Fixed footnote link colors and did some cleanup 2017-11-05 15:20:36 +01:00
squidfunk
2bdb031c35 Added clearer notes on docker image 2017-11-05 14:41:47 +01:00
squidfunk
64a09ec0f2 Cleaned up documentation and migration guide 2017-11-05 14:41:47 +01:00
squidfunk
dec7e21243 Fixed buttons in getting started guide 2017-11-03 14:27:44 +01:00
squidfunk
e8200730b3 Added Russian translations 2017-11-01 14:05:18 +01:00
squidfunk
f4dddaeeee Fixed favicon regression caused by deprecation upstream 2017-11-01 12:07:30 +01:00
squidfunk
c5143e890f Prepare 2.0.0 release 2017-10-31 20:29:30 +01:00
squidfunk
a36bfae62a Added documentation on migration 2017-10-31 20:07:11 +01:00
squidfunk
f68d7beb94 Updated documentation and simplified search tokenizer configuration 2017-10-31 20:07:11 +01:00
squidfunk
b093490b02 Prepare 1.12.2 release 2017-10-26 21:57:44 +02:00
squidfunk
c94457aa3f Prepare 1.12.1 release 2017-10-22 22:06:55 +02:00
squidfunk
b8b245a1b8 Prepare 1.12.0 release 2017-10-20 09:42:43 +02:00
Jonas Fonseca
eda4ff2c14 Add Danish translation
References 
2017-10-20 09:09:41 +02:00
squidfunk
0ab84b02ed Added documentation for language configuration 2017-10-19 21:11:18 +02:00
squidfunk
9c3134750e Fixed backward compatibility for localization 2017-10-18 21:56:53 +02:00
Jonas Fonseca
91aacd5493 Fix typo in site search section 2017-10-18 18:37:08 +02:00
Waylan Limberg
b955abab6e Removed deprecated Markdown config format in docs
* Remove deprecated Markdown config format in docs.

Support for including Markdown extension configs in the extension name has been [deprecated][1] and will not work in any future released of Python-Markdown. MkDocs has offered full support for defining extension configs [since version 0.13][2] and everyone should be using that format.

[1]: https://pythonhosted.org/Markdown/release-2.6.html#extension-configuration-as-part-of-extension-name-deprecated
[2]: http://www.mkdocs.org/about/release-notes/#other-changes-and-additions-to-version-0130

* Update codehilite Markdown config

* Update TOC Markdown configs

* Update pymdown Markdown configs
2017-10-16 19:13:05 +02:00
Jonas Fonseca
7ca03c017d Fix a typo and use question admonition 2017-10-13 16:08:40 +02:00
squidfunk
43484824ee Added notes on icon logo to documentation 2017-09-01 20:25:08 +07:00
squidfunk
4d4c76c979 Added basic implementation for details 2017-08-29 13:17:26 +07:00
squidfunk
3b6ee1e1cb Prepare 1.8.0 release 2017-08-02 14:35:07 +02:00
squidfunk
bbb3455c52 Added support for lazy rendering of search results 2017-08-02 14:09:13 +02:00
squidfunk
4887a7e062 Added note to documentation on Disqus integration 2017-07-25 16:26:10 +02:00
squidfunk
546a32f87a Corrected social links 2017-07-20 14:42:04 +02:00
Christian Oliff
e3bfb68115 Correct Disqus typo 2017-07-18 09:08:08 +02:00
squidfunk
32f6d63a29 Added note on examples 2017-06-21 10:36:23 +02:00
squidfunk
c586f9a799 Fixed wrong variable reference in localization docs 2017-06-01 10:07:23 +02:00
squidfunk
dcb0ee3f22 Added documentation for site search localization 2017-06-01 09:43:54 +02:00
squidfunk
9a24b60cdf Removed references to Clipboard from docs 2017-05-31 16:53:05 +02:00
squidfunk
13cd1d1a26 Merge branch 'master' into feature/clipboard-js-integration 2017-05-31 15:31:17 +02:00
Siva Sankar
056e91e9f4 Update the documentation for Discus Integration
'site_url' field is mandatory in the 'mkdocs.yml' file for the Disqus Integration to work, else it will display the error message as "We were unable to load Disqus. If you are a moderator please see our troubleshooting guide."
2017-05-20 22:12:47 +02:00
facelessuser
4b6ffe6628 Add clipboard.js support 2017-05-15 18:31:10 -06:00
Oscar Vasquez
e7a72a3d5d Added missing documentation for the site_favicon option 2017-05-11 11:55:23 +02:00
Christian Oliff
5e9ee23b9b Typo fix 'show' should be 'shown'
Typo fix 'show' should be 'shown'
2017-04-28 17:08:03 +02:00
squidfunk
6336e5055c Added language from localizations to HTML tag 2017-04-22 14:55:21 +02:00
squidfunk
3c1eb193bc Added new placeholders to documentation [ci skip] 2017-03-24 20:02:27 +01:00
squidfunk
59b2ae1a9d Smaller tweaks on documentation 2017-03-11 18:40:44 +01:00
squidfunk
34b09a6724 Added missing documentation for features 2017-03-11 18:40:44 +01:00
squidfunk
b8f4b62b72 Added documentation for edit_uri configuration 2017-03-11 18:40:44 +01:00
squidfunk
7cf5d428a4 Added documentation for Metadata extension 2017-03-11 18:40:44 +01:00
squidfunk
159466d448 Removed test code from docs 2017-03-11 14:42:55 +01:00
squidfunk
a911dd31b3 Added source file links, have to fix repaints 2017-03-11 14:42:55 +01:00
squidfunk
a58904c8c2 Replaced all occurrences of npm with yarn 2017-02-26 19:44:56 +01:00
squidfunk
de3bd8d665 Added disqus integration 2017-02-24 22:58:30 +01:00
squidfunk
ad39b98734 Updated badges [ci skip] 2017-02-24 22:05:49 +01:00
squidfunk
c691fff501 Prepare 1.0.2 release 2017-01-15 11:24:32 +01:00
squidfunk
eea4ebdaf4 Updated Dockerfile and added documentation 2017-01-14 19:24:07 +01:00