From 8a8fe982e2468ea12dbbf54a7877e0717530c92e Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 8 Jan 2017 23:21:45 +0100 Subject: [PATCH] Updated changelog and added release notes --- CHANGELOG | 10 ++- docs/getting-started.md | 8 ++- docs/release-notes.md | 140 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 151 insertions(+), 7 deletions(-) create mode 100644 docs/release-notes.md diff --git a/CHANGELOG b/CHANGELOG index 5b1f31131..b84231628 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,6 +1,4 @@ -mkdocs-material-1.0.0 (2017-01-12) - - The theme has been entirely rewritten from scratch. +mkdocs-material-1.0.0 (2017-01-13) * Introduced Webpack for more sophisticated JavaScript bundling * Introduced ESLint and Stylelint for code style checks @@ -27,7 +25,7 @@ mkdocs-material-1.0.0 (2017-01-12) * Added more detailed documentation on specimen, extensions etc. * Added a 404.html error page for deployment on GitHub Pages * Fixed live reload chain in watch mode when saving a template - * Fixed variable references to work with mkdocs 0.16 + * Fixed variable references to work with MkDocs 0.16 mkdocs-material-0.2.4 (2016-06-26) @@ -44,7 +42,7 @@ mkdocs-material-0.2.3 (2016-05-16) mkdocs-material-0.2.2 (2016-03-20) - * Fixed #15: Document pygments dependency for codehilite + * Fixed #15: Document Pygments dependency for CodeHilite * Fixed #16: Favicon could not be set through mkdocs.yml * Fixed #17: Put version into own container for styling * Fixed #20: Fix rounded borders for tables @@ -87,7 +85,7 @@ mkdocs-material-0.1.1 (2016-02-11) * Updated NPM and Bower dependencies to most recent versions * Changed footer/copyright link to Material theme to GitHub pages * Made MkDocs building/serving in build process optional - * Set up continuous integration with travis-ci.org + * Set up continuous integration with Travis mkdocs-material-0.1.0 (2016-02-09) diff --git a/docs/getting-started.md b/docs/getting-started.md index fbcf041d1..d2b017958 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -279,7 +279,7 @@ google_analytics: ### Localization L10N -In order to localize the labels (e.g. "Previous" and "Next" in the footer), +In order to localize the labels (e.g. *Previous* and *Next* in the footer), you can override the file `partials/i18n.html` to provide your own translations inside the macro `t`: @@ -297,6 +297,12 @@ inside the macro `t`: Just copy the file from the original theme and make your adjustments. See the section on [overriding partials][11] in the customization guide. +!!! warning "Migrating from Material 0.2.x" + + In 0.2.x, localization was done within the `extra` configuration of your + `mkdocs.yml`. With 1.0.0 this is no longer possible as the configuration + will be ignored. + [11]: customization.md#overriding-partials ### More advanced customization diff --git a/docs/release-notes.md b/docs/release-notes.md new file mode 100644 index 000000000..88adb7959 --- /dev/null +++ b/docs/release-notes.md @@ -0,0 +1,140 @@ +# Release Notes + +## Upgrading + +To upgrade Material to the latest version, use pip: + +``` sh +pip install --upgrade mkdocs-material +``` + +To determine the currently installed version, use the following command: + +``` sh +pip show mkdocs-material | grep -E ^Version +# Version 1.0.0 +``` + +## Changelog + +### 1.0.0 _ January 13, 2017 + +* Introduced Webpack for more sophisticated JavaScript bundling +* Introduced ESLint and Stylelint for code style checks +* Introduced more accurate Material Design colors and shadows +* Introduced modular scales for harmonic font sizing +* Introduced git-hooks for better development workflow +* Rewrite of CSS using the BEM methodology and SassDoc guidelines +* Rewrite of JavaScript using ES6 and Babel as a transpiler +* Rewrite of Admonition, Permalinks and Codehilite integration +* Rewrite of the complete typographical system +* Rewrite of Gulp asset pipeline in ES6 and separation of tasks +* Removed Bower as a dependency in favor of NPM +* Removed custom icon build in favor of the Material Design iconset +* Removed `_blank` targets on links due to vulnerability: http://bit.ly/1Mk2Rtw +* Removed unversioned assets from build directory +* Restructured templates into base templates and partials +* Added build and watch scripts in `package.json` +* Added support for Metadata and Footnotes Markdown extensions +* Added support for PyMdown Extensions package +* Added support for collapsible sections in navigation +* Added support for separate table of contents +* Added support for better accessibility through REM-based layout +* Added icons for GitHub, GitLab and BitBucket integrations +* Added more detailed documentation on specimen, extensions etc. +* Added a `404.html` error page for deployment on GitHub Pages +* Fixed live reload chain in watch mode when saving a template +* Fixed variable references to work with MkDocs 0.16 + +### 0.2.4 _ June 26, 2016 + +* Fixed improperly set default favicon +* Fixed [#33][33]: Protocol relative URL for webfonts doesn't work with + `file://` +* Fixed [#34][34]: IE11 on Windows 7 doesn't honor `max-width` on `main` tag +* Fixed [#35][35]: Add styling for blockquotes + + [33]: https://github.com/squidfunk/mkdocs-material/issues/25 + [34]: https://github.com/squidfunk/mkdocs-material/issues/26 + [35]: https://github.com/squidfunk/mkdocs-material/issues/30 + +### 0.2.3 _ May 16, 2016 + +* Fixed [#25][25]: Highlight inline fenced blocks +* Fixed [#26][26]: Better highlighting for keystrokes +* Fixed [#30][30]: Suboptimal syntax highlighting for PHP + + [25]: https://github.com/squidfunk/mkdocs-material/issues/25 + [26]: https://github.com/squidfunk/mkdocs-material/issues/26 + [30]: https://github.com/squidfunk/mkdocs-material/issues/30 + +### 0.2.2 _ March 20, 2016 + +* Fixed [#15][15]: Document Pygments dependency for CodeHilite +* Fixed [#16][16]: Favicon could not be set through `mkdocs.yml` +* Fixed [#17][17]: Put version into own container for styling +* Fixed [#20][20]: Fix rounded borders for tables + + [15]: https://github.com/squidfunk/mkdocs-material/issues/15 + [16]: https://github.com/squidfunk/mkdocs-material/issues/16 + [17]: https://github.com/squidfunk/mkdocs-material/issues/17 + [20]: https://github.com/squidfunk/mkdocs-material/issues/20 + +### 0.2.1 _ March 12, 2016 + +* Fixed [#10][10]: Invisible header after closing search bar with + ESC key +* Fixed [#13][13]: Table cells don't wrap +* Fixed empty list in table of contents when no headline is defined +* Corrected wrong path for static asset monitoring in Gulpfile.js +* Set up tracking of site search for Google Analytics + + [10]: https://github.com/squidfunk/mkdocs-material/issues/10 + [13]: https://github.com/squidfunk/mkdocs-material/issues/13 + +### 0.2.0 _ February 24, 2016 + +* Fixed [#6][6]: Include multiple color palettes via `mkdocs.yml` +* Fixed [#7][7]: Better colors for links inside admonition notes and warnings +* Fixed [#9][9]: Text for prev/next footer navigation should be customizable +* Refactored templates (replaced `if`/`else` with modifiers where possible) + + [6]: https://github.com/squidfunk/mkdocs-material/issues/6 + [7]: https://github.com/squidfunk/mkdocs-material/issues/7 + [9]: https://github.com/squidfunk/mkdocs-material/issues/9 + +### 0.1.3 _ February 21, 2016 + +* Fixed [#3][3]: Ordered lists within an unordered list have `::before` content +* Fixed [#4][4]: Click on Logo/Title without Github-Repository: `"None"` +* Fixed [#5][5]: Page without headlines renders empty list in table of contents +* Moved Modernizr to top to ensure basic usability in IE8 + + [3]: https://github.com/squidfunk/mkdocs-material/issues/3 + [4]: https://github.com/squidfunk/mkdocs-material/issues/4 + [5]: https://github.com/squidfunk/mkdocs-material/issues/5 + +### 0.1.2 _ February 16, 2016 + +* Fixed styles for deep navigational hierarchies +* Fixed webfont delivery problem when hosted in subdirectories +* Fixed print styles in mobile/tablet configuration +* Added option to configure fonts in `mkdocs.yml` with fallbacks +* Changed styles for admonition notes and warnings +* Set download link to latest version if available +* Set up tracking of outgoing links and actions for Google Analytics + +### 0.1.1 _ February 11, 2016 + +* Fixed [#1][1]: GitHub stars don't work if the repo_url ends with a `/` +* Updated NPM and Bower dependencies to most recent versions +* Changed footer/copyright link to Material theme to GitHub pages +* Made MkDocs building/serving in build process optional +* Set up continuous integration with [Travis][2] + + [1]: https://github.com/squidfunk/mkdocs-material/issues/1 + [2]: https://travis-ci.org + +### 0.1.0 _ February 9, 2016 + +* Initial release