forked from squidfunk/mkdocs-material
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CHANGELOG
543 lines (378 loc) · 18.9 KB
/
CHANGELOG
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
mkdocs-material-2.7.3 (2018-04-26)
* Added Finnish translations
mkdocs-material-2.7.2 (2018-04-09)
* Fixed rendering issue for details on Edge
mkdocs-material-2.7.1 (2018-03-21)
* Added Galician translations
* Fixed #730: Scroll chasing error on home page if Disqus is enabled
* Fixed #736: Reset drawer and search upon back button invocation
mkdocs-material-2.7.0 (2018-03-06)
* Added ability to set absolute URL for logo
* Added Hebrew translations
mkdocs-material-2.6.6 (2018-02-22)
* Added preconnect for Google Fonts for faster loading
* Fixed #710: With tabs sidebar disappears if JavaScript is not available
mkdocs-material-2.6.5 (2018-02-22)
* Reverted --dev-addr flag removal from Dockerfile
mkdocs-material-2.6.4 (2018-02-21)
* Added Catalan translations
* Fixed incorrect margins for buttons in Firefox and Safari
* Replaced package manager yarn with npm 5.6
* Reverted GitHub stars rounding method
* Removed --dev-addr flag from Dockerfile for Windows compatibility
mkdocs-material-2.6.3 (2018-02-18)
* Added Vietnamese translations
mkdocs-material-2.6.2 (2018-02-12)
* Added Arabic translations
* Fixed incorrect rounding of amount of GitHub stars
* Fixed double-layered borders for tables
mkdocs-material-2.6.1 (2018-02-11)
* Added ability to override Disqus integration using metadata
* Fixed #690: Duplicate slashes in source file URLs
* Fixed #696: Active page highlight not working with default palette
* Adjusted German translations
mkdocs-material-2.6.0 (2018-02-02)
* Moved default search configuration to default translation (English)
* Added support to automatically set text direction from translation
* Added support to disable search stop word filter in translation
* Added support to disable search trimmer in translation
* Added Persian translations
* Fixed support for Polish search
* Fixed disappearing GitHub, GitLab and Bitbucket repository icons
mkdocs-material-2.5.5 (2018-01-31)
* Added Hungarian translations
mkdocs-material-2.5.4 (2018-01-29)
* Fixed #683: gh-deploy fails inside Docker
mkdocs-material-2.5.3 (2018-01-25)
* Added Ukrainian translations
mkdocs-material-2.5.2 (2018-01-22)
* Added default search language mappings for all localizations
* Fixed #673: Error loading non-existent search language
* Fixed #675: Uncaught reference error when search plugin disabled
mkdocs-material-2.5.1 (2018-01-20)
* Fixed permalink for main headline
* Improved missing translation handling with English as a fallback
* Improved accessibility with skip-to-content link
mkdocs-material-2.5.0 (2018-01-13)
* Added support for right-to-left languages
mkdocs-material-2.4.0 (2018-01-11)
* Added focus state for clipboard buttons
* Fixed #400: Search bar steals tab focus
* Fixed search not closing on ENTER when result is selected
* Fixed search not closing when losing focus due to TAB
* Fixed collapsed navigation links getting focus
* Fixed outline being cut off on TAB focus of navigation links
* Fixed bug with first search result navigation being ignored
* Removed search result navigation via TAB (use UP and DOWN)
* Removed outline resets for links
* Improved general tabbing behavior on desktop
mkdocs-material-2.3.0 (2018-01-09)
* Added example (synonym: snippet) style for Admonition
* Added synonym abstract for summary style for Admonition
mkdocs-material-2.2.6 (2017-12-27)
* Added Turkish translations
* Fixed unclickable area below header in case JavaScript is not available
mkdocs-material-2.2.5 (2017-12-18)
* Fixed #639: Broken default favicon
mkdocs-material-2.2.4 (2017-12-18)
* Fixed #638: Build breaks with Jinja < 2.9
mkdocs-material-2.2.3 (2017-12-13)
* Fixed #630: Admonition sets padding on any last child
* Adjusted Chinese (Traditional) translations
mkdocs-material-2.2.2 (2017-12-08)
* Added Dutch translations
* Adjusted targeted link and footnote offsets
* Simplified Admonition styles and fixed padding bug
mkdocs-material-2.2.1 (2017-12-02)
* Fixed #616: Minor styling error with title-only admonition blocks
* Removed border for table of contents and improved spacing
mkdocs-material-2.2.0 (2017-11-22)
* Added support for hero teaser
* Added Portuguese translations
* Fixed #586: Footnote backref target offset regression
* Fixed #605: Search stemmers not correctly loaded
mkdocs-material-2.1.1 (2017-11-21)
* Replaced deprecated babel-preset-es2015 with babel-preset-env
* Refactored Gulp build pipeline with Webpack
* Removed right border on sidebars
* Fixed broken color transition on header
mkdocs-material-2.1.0 (2017-11-19)
* Added support for white as a primary color
* Added support for sliding site name and title
* Fixed redundant clipboard button when using line numbers on code blocks
* Improved header appearance by making it taller
* Improved tabs appearance
* Improved CSS customizability by leveraging inheritance
* Removed scroll shadows via background-attachment
* Removed breadcrumbs from header
mkdocs-material-2.0.4 (2017-11-05)
* Fixed details not opening with footnote reference
mkdocs-material-2.0.3 (2017-11-05)
* Added Japanese translations
* Fixed #540: Jumping to anchor inside details doesn't open it
* Fixed active link colors in footer
mkdocs-material-2.0.2 (2017-11-01)
* Added Russian translations
* Fixed #542: Horizontal scrollbar between 1220px and 1234px
* Fixed #553: Metadata values only rendering first character
* Fixed #558: Flash of unstyled content
* Fixed favicon regression caused by deprecation upstream
mkdocs-material-2.0.1 (2017-10-31)
* Fixed error when initializing search
* Fixed styles for link to edit the current page
* Fixed styles on nested admonition in details
mkdocs-material-2.0.0 (2017-10-31)
* Added support for MkDocs 0.17.1 theme configuration options
* Added support for easier configuration of search tokenizer
* Added support to disable search
* Added Korean translations
* Removed support for MkDocs 0.16.x
mkdocs-material-1.12.2 (2017-10-26)
* Added Italian, Norwegian, French and Chinese translations
mkdocs-material-1.12.1 (2017-10-22)
* Added Polish, Swedish and Spanish translations
* Improved downward compatibility with custom partials
* Temporarily pinned MkDocs version within Docker image to 0.16.3
* Fixed #519: Missing theme configuration file
mkdocs-material-1.12.0 (2017-10-20)
* Added support for setting language(s) via mkdocs.yml
* Added support for default localization
* Added German and Danish translations
* Fixed #374: Search bar misalignment on big screens
mkdocs-material-1.11.0 (2017-10-19)
* Added localization to clipboard
* Refactored localization logic
mkdocs-material-1.10.4 (2017-10-18)
* Improved print styles of code blocks
* Improved search UX (don't close on enter if no selection)
* Fixed #495: Vertical scrollbar on short pages
mkdocs-material-1.10.3 (2017-10-11)
* Fixed #484: Vertical scrollbar on some MathJax formulas
* Fixed #483: Footnote backref target offset regression
mkdocs-material-1.10.2 (2017-10-06)
* Fixed #468: Sidebar shows scrollbar if content is shorter (in Safari)
mkdocs-material-1.10.1 (2017-09-14)
* Fixed #455: Bold code blocks rendered with normal font weight
mkdocs-material-1.10.0 (2017-09-01)
* Added support to make logo default icon configurable
* Fixed uninitialized overflow scrolling on main pane for iOS
* Fixed error in mobile navigation in case JavaScript is not available
* Fixed incorrect color transition for nested panes in mobile navigation
* Improved checkbox styles for Tasklist from PyMdown Extension package
mkdocs-material-1.9.0 (2017-08-29)
* Added info (synonym: todo) style for Admonition
* Added question (synonym: help, faq) style for Admonition
* Added support for Details from PyMdown Extensions package
* Improved Admonition styles to match Details
* Improved styles for social links in footer
* Replaced ligatures with Unicode code points to avoid broken layout
* Upgraded PyMdown Extensions package dependency to >= 3.4
mkdocs-material-1.8.1 (2017-08-07)
* Fixed #421: Missing pagination for GitHub API
mkdocs-material-1.8.0 (2017-08-02)
* Added support for lazy-loading of search results for better performance
* Added support for customization of search tokenizer/separator
* Fixed #424: Search doesn't handle capital letters anymore
* Fixed #419: Search doesn't work on whole words
mkdocs-material-1.7.5 (2017-07-25)
* Fixed #398: Forms broken due to search shortcuts
* Improved search overall user experience
* Improved search matching and highlighting
* Improved search accessibility
mkdocs-material-1.7.4 (2017-06-21)
* Fixed functional link colors in table of contents for active palette
* Fixed #368: Compatibility issues with IE11
mkdocs-material-1.7.3 (2017-06-07)
* Fixed error when setting language to Japanese for site search
mkdocs-material-1.7.2 (2017-06-06)
* Fixed offset of search box when repo_url is not set
* Fixed non-disappearing tooltip
mkdocs-material-1.7.1 (2017-06-01)
* Fixed wrong z-index order of header, overlay and drawer
* Fixed wrong offset of targeted footnote back references
mkdocs-material-1.7.0 (2017-06-01)
* Added "copy to clipboard" buttons to code blocks
* Added support for multilingual site search
* Fixed search term highlighting for non-latin languages
mkdocs-material-1.6.4 (2017-05-24)
* Fixed #337: JavaScript error for GitHub organization URLs
mkdocs-material-1.6.3 (2017-05-16)
* Fixed #329: Broken source stats for private or unknown GitHub repos
mkdocs-material-1.6.2 (2017-05-15)
* Fixed #316: Fatal error for git clone on Windows
* Fixed #320: Chrome 58 creates double underline for abbr tags
* Fixed #323: Ligatures rendered inside code blocks
* Fixed miscalculated sidebar height due to missing margin collapse
* Changed deprecated MathJax CDN to Cloudflare
mkdocs-material-1.6.1 (2017-04-23)
* Fixed following of active/focused element if search input is focused
* Fixed layer order of search component elements
mkdocs-material-1.6.0 (2017-04-22)
* Added build test for Docker image on Travis
* Added search overlay for better user experience (focus)
* Added language from localizations to html tag
* Fixed #270: Source links broken for absolute URLs
* Fixed missing top spacing for first targeted element in content
* Fixed too small footnote divider when using larger font sizes
mkdocs-material-1.5.5 (2017-04-20)
* Fixed #282: Browser search (META+F) is hijacked
mkdocs-material-1.5.4 (2017-04-08)
* Fixed broken highlighting for two or more search terms
* Fixed missing search results when only a h1 is present
* Fixed unresponsive overlay on Android
mkdocs-material-1.5.3 (2017-04-07)
* Fixed deprecated calls for template variables
* Fixed wrong palette color for focused search result
* Fixed JavaScript errors on 404 page
* Fixed missing top spacing on 404 page
* Fixed missing right spacing on overflow of source container
mkdocs-material-1.5.2 (2017-04-05)
* Added requirements as explicit dependencies in setup.py
* Fixed non-synchronized transitions in search form
mkdocs-material-1.5.1 (2017-03-30)
* Fixed rendering and offset of targetted footnotes
* Fixed #238: Link on logo is not set to site_url
mkdocs-material-1.5.0 (2017-03-24)
* Added support for localization of search placeholder
* Added keyboard events for quick access of search
* Added keyboard events for search control
* Added opacity on hover for search buttons
* Added git hook to skip CI build on non-src changes
* Fixed non-resetting search placeholder when input is cleared
* Fixed error for unescaped parentheses in search term
* Fixed #229: Button to clear search missing
* Fixed #231: Escape key doesn't exit search
* Removed old-style figures from font feature settings
mkdocs-material-1.4.1 (2017-03-16)
* Fixed invalid destructuring attempt on NodeList (in Safari, Edge, IE)
mkdocs-material-1.4.0 (2017-03-16)
* Added support for grouping searched sections by documents
* Added support for highlighting of search terms
* Added support for localization of search results
* Fixed #216: table of contents icon doesn't show if h1 is not present
* Reworked style and layout of search results for better usability
mkdocs-material-1.3.0 (2017-03-11)
* Added support for page-specific title and description using metadata
* Added support for linking source files to documentation
* Fixed jitter and offset of sidebar when zooming browser
* Fixed incorrectly initialized tablet sidebar height
* Fixed regression for #1: GitHub stars break if the repo_url ends with a '/'
* Fixed undesired white line below copyright footer due to base font scaling
* Fixed issue with whitespace in path for scripts
* Fixed #205: support non-fixed (static) header
* Refactored footnote references for better visibility
* Reduced repaints to a minimum for non-tabs configuration
* Reduced contrast of edit button (slightly)
mkdocs-material-1.2.0 (2017-03-03)
* Added quote (synonym: cite) style for Admonition
* Added help message to build pipeline
* Fixed wrong navigation link colors when applying palette
* Fixed #197: Link missing in tabs navigation on deeply nested items
* Removed unnecessary dev dependencies
mkdocs-material-1.1.1 (2017-02-26)
* Fixed incorrectly displayed nested lists when using tabs
mkdocs-material-1.1.0 (2017-02-26)
* Added tabs navigation feature (optional)
* Added Disqus integration (optional)
* Added a high resolution Favicon with the new logo
* Added static type checking using Facebook's Flow
* Fixed #173: Dictionary elements have no bottom spacing
* Fixed #175: Tables cannot be set to 100% width
* Fixed race conditions in build related to asset revisioning
* Fixed accidentally re-introduced Permalink on top-level headline
* Fixed alignment of logo in drawer on IE11
* Refactored styles related to tables
* Refactored and automated Docker build and PyPI release
* Refactored build scripts
mkdocs-material-1.0.5 (2017-02-18)
* Fixed #153: Sidebar flows out of constrained area in Chrome 56
* Fixed #159: Footer jitter due to JavaScript if content is short
mkdocs-material-1.0.4 (2017-02-16)
* Fixed #142: Documentation build errors if h1 is defined as raw HTML
* Fixed #164: PyPI release does not build and install
* Fixed offsets of targeted headlines
* Increased sidebar font size by 0.12rem
mkdocs-material-1.0.3 (2017-01-22)
* Fixed #117: Table of contents items don't blur on fast scrolling
* Refactored sidebar positioning logic
* Further reduction of repaints
mkdocs-material-1.0.2 (2017-01-15)
* Fixed #108: Horizontal scrollbar in content area
mkdocs-material-1.0.1 (2017-01-14)
* Fixed massive repaints happening when scrolling
* Fixed footer back reference positions in case of overflow
* Fixed header logo from showing when the menu icon is rendered
* Changed scrollbar behavior to only show when content overflows
mkdocs-material-1.0.0 (2017-01-13)
* 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
mkdocs-material-0.2.4 (2016-06-26)
* Fixed improperly set default favicon
* Fixed #33: Protocol relative URL for webfonts doesn't work with file://
* Fixed #34: IE11 on Windows 7 doesn't honor max-width on main tag
* Fixed #35: Add styling for blockquotes
mkdocs-material-0.2.3 (2016-05-16)
* Fixed #25: Highlight inline fenced blocks
* Fixed #26: Better highlighting for keystrokes
* Fixed #30: Suboptimal syntax highlighting for PHP
mkdocs-material-0.2.2 (2016-03-20)
* 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
mkdocs-material-0.2.1 (2016-03-12)
* Fixed #10: Invisible header after closing search bar with ESC key
* Fixed #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
mkdocs-material-0.2.0 (2016-02-24)
* Fixed #6: Include multiple color palettes via mkdocs.yml
* Fixed #7: Better colors for links inside admonition notes and warnings
* Fixed #9: Text for prev/next footer navigation should be customizable
* Refactored templates (replaced if/else with modifiers where possible)
mkdocs-material-0.1.3 (2016-02-21)
* Fixed #3: Ordered lists within an unordered list have ::before content
* Fixed #4: Click on Logo/Title without Github-Repository: "None"
* Fixed #5: Page without headlines renders empty list in table of contents
* Moved Modernizr to top to ensure basic usability in IE8
mkdocs-material-0.1.2 (2016-02-16)
* 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
mkdocs-material-0.1.1 (2016-02-11)
* Fixed #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
mkdocs-material-0.1.0 (2016-02-09)
* Initial release