1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-14 19:07:41 +01:00
Commit Graph

2275 Commits

Author SHA1 Message Date
Simon Marquis
992e882ee3
Documentation (#7059)
See https://squidfunk.github.io/mkdocs-material/contributing/#contributing_1
2024-04-18 07:29:29 +07:00
Alexander Voss
324ccdb737
Documentation (#7054) 2024-04-16 21:31:51 +07:00
squidfunk
3b592abc21
Prepare 9.5.18 release 2024-04-16 10:46:11 +07:00
squidfunk
cd086110bf
Updated dependencies 2024-04-08 13:55:41 +08:00
Hudson
0e8ed32bda
Added missing icons and their defaults to JSON schema (#7020)
* add missing `icon`s to theme schema

https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/?h=icons#site-icons

* Add missing schema defaults
2024-04-07 07:43:56 +08:00
squidfunk
68126abb56
Updated Insiders changelog 2024-04-05 09:55:42 +08:00
squidfunk
570161ab3f
Prepare 9.5.17 release 2024-04-02 13:13:23 +08:00
Andreas Deininger
7e13ae602f Fix typos 2024-04-01 16:50:08 +02:00
Kuan-Yi Li
7d6d8d7a7c Updated slugify documentation
Unicode, case-sensitive reference setting causes error below.

```
yaml.constructor.ConstructorError: expected a mapping node, but found scalar
```

Update related sections in the documentation to address this issue.

Newer Python-Markdown has `slugify_unicode` built-in, so this

```yaml
markdown_extensions:
  - toc:
      slugify: !!python/name:markdown.extensions.toc.slugify_unicode
```

also works for case-insensitive use cases.

Fixes: ee1e675da6 ("Update slug reference")
2024-04-01 07:34:10 +08:00
squidfunk
8956524097
Updated Insiders changelog 2024-03-31 17:35:08 +08:00
squidfunk
0db4e667da
Updated changelog 2024-03-31 17:33:14 +08:00
squidfunk
6c9ba875bf
Prepare 9.5.16 release 2024-03-31 17:20:16 +08:00
Julien
a2cb35d4c5
Improved error handling on social plugin (#6818)
* fix(social): CairoSVG OSError handling in social plugin

Related issue: #6817

Co-authored-by: Guts <1596222+Guts@users.noreply.github.com>

* feat(docs): Add troubleshooting guide for CairoSVG crash

---------

Co-authored-by: Kamil Krzyśków <kamilzary@gmail.com>
Co-authored-by: Guts <1596222+Guts@users.noreply.github.com>
Co-authored-by: Martin Donath <martin.donath@squidfunk.com>
2024-03-31 17:00:27 +08:00
squidfunk
f27b93ece3
Updated dependencies 2024-03-27 18:11:52 +08:00
squidfunk
5458039778
Updated Insiders changelog 2024-03-23 13:38:07 +08:00
squidfunk
99d15d158f
Prepare 9.5.15 release 2024-03-23 13:26:32 +08:00
Meysam
1b2d48455d
Documentation (#6951) 2024-03-22 13:53:49 +08:00
squidfunk
495c64e719
Restructured funding goals 2024-03-20 15:59:01 +08:00
squidfunk
8addc95d9d
Added support for font variants in social plugin 2024-03-20 15:45:21 +08:00
Steven Maude
3f09228249
Documentation (#6933)
To "commercial use" section.
2024-03-20 08:52:05 +08:00
squidfunk
cc78979185
Updated Insiders changelog 2024-03-18 07:40:29 +07:00
squidfunk
c51eb2ff83
Prepare 9.5.14 release 2024-03-18 07:25:21 +07:00
squidfunk
3311a615fa
Updated dependencies 2024-03-18 07:19:31 +07:00
squidfunk
dc97a56659
Updated dependencies 2024-03-12 09:59:20 +07:00
squidfunk
fdeafbb875
Documentation 2024-03-09 14:22:56 +07:00
Blake Netzeband
9d387d0428
Added schema reference to mkdocs-table-reader-plugin (#6887) 2024-03-09 08:23:28 +07:00
Berk Karaal
6b239db64e
Documentation (#6878) 2024-03-06 17:10:28 +07:00
squidfunk
c8a2142263
Updated Premium sponsors 2024-03-06 13:22:40 +07:00
squidfunk
800b07ea50
Updated Insiders changelog 2024-03-06 13:12:51 +07:00
squidfunk
6ace043247
Updated changelog 2024-03-06 13:03:04 +07:00
squidfunk
36e9cff9db
Prepare 9.5.13 release 2024-03-06 13:01:06 +07:00
Y.D.X
c7de6ef260
Documentation (#6873)
The section was moved to a new page.
2024-03-06 07:23:30 +07:00
squidfunk
dc808ca90a
Updated dependencies 2024-03-05 11:01:58 +07:00
squidfunk
3e862b5e99
Updated changelog 2024-03-01 07:27:51 +07:00
squidfunk
5108432a39
Updated changelog 2024-02-29 10:20:08 +07:00
Kathi
7b83b57d1c
Updated contributing guide (#6843) 2024-02-27 16:14:17 +07:00
squidfunk
6c2e0290e1
Updated Premium sponsors 2024-02-27 11:35:04 +07:00
squidfunk
b5a5fde436
Updated dependencies 2024-02-26 11:47:29 +07:00
Kathi
f7eb5c893b
Updated Contributing guide (#6820) 2024-02-24 13:41:32 +07:00
Kathi
9a79e1ecf4
Updated Contributing Guide (#6819) 2024-02-24 13:19:18 +07:00
squidfunk
be21a6ff2d
Prepare 9.5.11 release 2024-02-24 12:53:48 +07:00
squidfunk
f26cfaaa58
Documentation 2024-02-24 12:46:13 +07:00
squidfunk
23f18866c3
Removed manually added instant previews in light of new extension 2024-02-22 20:24:08 +07:00
squidfunk
59f4147e60
Updated Insiders changelog 2024-02-21 11:12:50 +07:00
JJ Asghar
740552aa58
Documentation (#6803)
* Update icons-emojis.md

The link no longer works, it seems X has removed it completely.

* Updated per squidfunks suggestion.
2024-02-21 10:36:58 +07:00
squidfunk
b3e8f09001
Updated Premium sponsors 2024-02-20 20:36:48 +07:00
squidfunk
c8eea6b4a7
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2024-02-20 08:03:44 +07:00
squidfunk
7c586cd5cf
Updated Premium sponsors 2024-02-20 08:03:31 +07:00
Kathi
41d5633fdf
Updated FAQ and fixed links
* Updated FAQs

* Updated FAQ points and links

* Updated FAQ points

* Updated FAQ points

* Updated FAQ points
2024-02-19 13:49:52 +07:00
squidfunk
3348a2984a
Updated changelog 2024-02-19 13:32:50 +07:00
squidfunk
b688cfdd09
Updated changelog 2024-02-19 13:18:03 +07:00
squidfunk
fea265dedd
Prepare 9.5.10 release 2024-02-19 13:16:24 +07:00
squidfunk
adf061e103
Updated dependencies 2024-02-19 13:15:15 +07:00
squidfunk
3e2a1fcb7e
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2024-02-19 12:50:20 +07:00
squidfunk
2986aca629
Documentation 2024-02-19 12:48:18 +07:00
katharinalisalin
7922c8f45d Updated FAQs 2024-02-17 17:12:11 +07:00
katharinalisalin
f1673ecd0d Updated FAQs 2024-02-17 16:51:16 +07:00
katharinalisalin
e423784827 Updated FAQs 2024-02-17 16:23:36 +07:00
squidfunk
14b55c2f79
Updated premium sponsors 2024-02-17 12:23:58 +07:00
squidfunk
55603a70e8
Updated dependencies 2024-02-12 19:19:41 +07:00
katharinalisalin
6ce9194c07 Updated FAQs 2024-02-11 15:46:30 +07:00
katharinalisalin
9f549e48ab Updated FAQs 2024-02-11 15:12:42 +07:00
katharinalisalin
1cfa437716 Updated FAQs 2024-02-11 13:34:29 +07:00
Martin Donath
52e9214341
Merge pull request #6761 from squidfunk/docs/faq-update-contributors
Docs/FAQ update
2024-02-11 13:02:42 +07:00
katharinalisalin
4e9d4234d7 Updated FAQs 2024-02-11 12:57:51 +07:00
katharinalisalin
ae4d375fbe Updated FAQs 2024-02-11 12:30:14 +07:00
squidfunk
a6286ef3ac
Prepare 9.5.9 release 2024-02-10 13:17:02 +07:00
squidfunk
1698fd8172
Documentation 2024-02-09 11:16:21 +07:00
squidfunk
860869be09
Updated Insiders changelog 2024-02-07 10:38:25 +07:00
squidfunk
3fb5f06793
Prepare 9.5.8 release 2024-02-07 10:32:47 +07:00
squidfunk
fc6b6dc904
Updated premium sponsors 2024-02-05 19:01:24 +07:00
squidfunk
4fc33f68ed
Added Tamil translations
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-02-05 10:49:44 +07:00
squidfunk
1df8e1f6dd
Documentation 2024-02-04 12:08:36 +07:00
squidfunk
f4960e8478
Prepare 9.5.7 release 2024-02-03 10:17:22 +07:00
Uwe Schmidt
dcb23d9a20
Update publishing-your-site.md
Remove fetch-depth for checkout action (revert)

Also update Insiders workflow.
2024-02-01 12:24:20 +01:00
Uwe Schmidt
c99f0cb4c5
Update GitHub Actions workflow
Update action versions for 'setup-python' and 'cache'.

Set 'fetch-depth: 0' for 'checkout' action to obtain correct document dates when using 'mkdocs-git-revision-date-localized-plugin' (cf. https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/blob/v1.2.2/mkdocs_git_revision_date_localized_plugin/ci.py#L37-L48)
2024-01-31 16:08:26 +01:00
squidfunk
5417afc004
Updated premium sponsors 2024-01-30 17:08:11 +07:00
squidfunk
175f2f08e5
Updated dependencies 2024-01-30 10:41:22 +07:00
squidfunk
8023ffef86
Documentation 2024-01-30 10:39:40 +07:00
squidfunk
bec0d9abc6
Updated Insiders changelog 2024-01-30 09:26:56 +07:00
squidfunk
d3d44cffb1
Documentation 2024-01-28 16:30:35 +07:00
squidfunk
7dbb2b0546
Documentation 2024-01-28 16:26:15 +07:00
squidfunk
294d38e8d3
Documentation 2024-01-28 15:51:25 +07:00
squidfunk
6026738819
Prepare 9.5.6 release 2024-01-28 15:26:56 +07:00
squidfunk
f55ce2c81b
Updated Insiders changelog 2024-01-24 15:46:35 +07:00
squidfunk
672414163c
Documentation 2024-01-24 15:45:24 +07:00
squidfunk
9d52e36212
Prepare 9.5.5 release 2024-01-24 11:00:36 +07:00
squidfunk
cd3a7182f3
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2024-01-23 09:55:25 +07:00
squidfunk
d9c939a956
Updated dependencies 2024-01-23 09:54:19 +07:00
Andre601
943fa495da
Update publishing-your-site.md 2024-01-22 00:52:38 +01:00
Andre601
5954ecd2fd
Merge branch 'master' into feature/add-codeberg-pages-guide-link 2024-01-22 00:50:42 +01:00
squidfunk
25ee8ca5bf
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2024-01-21 15:17:04 +07:00
squidfunk
c952491b47
Updated Premium sponsors 2024-01-21 15:16:51 +07:00
Martin Donath
7cc43931c8
Merge pull request #6663 from userbradley/master
[Publishing guide] Adding Fly.io
2024-01-20 08:54:18 +07:00
squidfunk
14d7874d0d
Documentation 2024-01-20 08:53:16 +07:00
Bradley
b24850ee2f
[publishing guide] Adding :material-airballoon-outline: for consistency 2024-01-19 15:32:34 +00:00
squidfunk
e8504fdffb
Updated Insiders changelog and documentation 2024-01-19 09:46:31 +07:00
Bradley
02ffbfb9ec
[publishing guide] Fomratting the link better 2024-01-18 15:16:02 +00:00
Bradley
4999ce7595
[publishing guide] Adding fly.io 2024-01-18 15:14:52 +00:00
squidfunk
44982451f7
Prepare 9.5.4 release 2024-01-15 17:36:27 +07:00
squidfunk
ab5ccbe6b8
Updated README 2024-01-10 09:00:08 +07:00
squidfunk
cca090bebb
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2024-01-09 17:40:46 +07:00
squidfunk
cfab7e39e0
Updated Insiders changelog 2024-01-09 17:40:34 +07:00
nicfv
55678a9316 Update dates to 2024 in blog setup page 2024-01-08 07:13:35 -08:00
squidfunk
608b4fcc6a
Updated Insiders changelog 2024-01-07 11:57:47 +07:00
Martin Donath
7c8ff087f8
Merge pull request #6584 from DanielHabenicht/patch-1
Update creating-your-site.md
2024-01-07 05:26:00 +01:00
Santhosh Kumar Srinivasan
54174785ee
Explicitly mention setting defaults is for insiders only (meta plugin)
As the meta plugin is reserved for insiders only, this section could also mention that so people don't run into the below error.

```
$ mkdocs serve
ERROR   -  Config value 'plugins': The "meta" plugin is not installed

Aborted with 1 configuration errors!
```
2024-01-06 17:08:24 +05:30
squidfunk
157c6dbd32
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2024-01-06 09:27:45 +07:00
squidfunk
7624e78744
Updated copyright year 2024-01-06 09:27:06 +07:00
Jimmy Wang
3f879eafde
Fix typo in SmartSymbols section
"e.h." is a typo for "e.g." in the description.
2024-01-06 01:17:18 +08:00
squidfunk
a1c1319528
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2024-01-05 16:16:17 +07:00
squidfunk
2a2a19b90e
Updated README 2024-01-05 16:04:28 +07:00
Nic
72536d9ed6
Merge branch 'squidfunk:master' into master 2024-01-04 18:59:32 -08:00
nicfv
9e016687b1 Update all dates in blog plugin page to 2024 2024-01-04 18:55:21 -08:00
nicfv
500178380d Update "short" date to be consistent 2024-01-04 11:59:07 -08:00
Rachel Rigdon
00caf1145a
Fixed typo in projects.md
Fixed a minor typo in the projects.md
2024-01-04 11:52:48 -06:00
DanielHabenicht
d6e1abb078
Update creating-your-site.md
use cmd instead of "Commandline"
2024-01-03 21:51:27 +01:00
DanielHabenicht
4c5228d55c
Update creating-your-site.md
make it clear that this command is aimed only aimed at Wind ows CommandLine users and generally windows users.
2024-01-03 16:01:24 +01:00
squidfunk
246266fafa
Updated Insiders changelog 2023-12-29 13:45:06 +01:00
squidfunk
2757f27819
Added documentation on new tags features 2023-12-29 13:32:19 +01:00
squidfunk
533d02e740
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2023-12-27 12:18:10 +01:00
squidfunk
0202126c17
Updated dependencies 2023-12-27 12:17:54 +01:00
Simon Marquis
fc75fcd79e
Documentation (#6568)
Closes #6567
2023-12-27 10:44:57 +01:00
squidfunk
43ed6fac8d
Updated Insiders changelog 2023-12-23 21:50:44 +01:00
squidfunk
ae1c63d43d
Updated Insiders changelog 2023-12-23 21:32:20 +01:00
squidfunk
284264a37e
Prepare 9.5.3 release 2023-12-23 21:12:18 +01:00
Alexander Voss
6b690e9acd
Documentation (#6549)
This is in response to
https://github.com/squidfunk/mkdocs-material/discussions/6542
to add a section on setting up navigation for a blog so that the archive
and category pages appear in the right place.
2023-12-21 09:37:24 +01:00
squidfunk
05596664a5
Updated dependencies 2023-12-18 16:08:14 +01:00
Sigurd Spieckermann
6e0b497ee8
Documentation (#6519) 2023-12-17 17:45:21 +01:00
Sigurd Spieckermann
1dc8bc004f
Documentation (#6514) 2023-12-16 12:50:32 +01:00
Alexander Voss
fc685e3a95
Documentation (#6506)
* added code and tooltips to custom site feedback

- clarifying that the feedback widget needs to be turned on
- showing how to disable the form and
- show the notes that are configured

* undoing a minor change that we unnecessary

- I changed a colon to a full stop at some point because I thought I
  would add another sentence, decided not to and then the unneeded
  change ended up in the previous commit.

* turned a comment I deleted into a tooltip
2023-12-14 09:23:29 +01:00
squidfunk
2ca5cf0ea0
Prepare 9.5.2 release 2023-12-11 16:21:03 +01:00
squidfunk
52feaba403
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2023-12-11 10:14:58 +01:00
squidfunk
649db51429
Updated dependencies 2023-12-11 10:14:32 +01:00
Ofek Lev
419898a337
Documentation (#6477) 2023-12-10 16:48:03 +01:00
Ofek Lev
6290ed7567
Documentation (#6474) 2023-12-10 10:27:32 +01:00
squidfunk
6c1cee0a01
Documentation 2023-12-09 22:27:33 +01:00
Alexander Voss
2bb907d0d9
Added guide for creating Pull Requests (#6429)
* added first draft of instructions for pull requests

* added a diagram to explain process

* added description of the process, moved specific instructions

- split the diagram into two parts to easy comperehension and
  allow people to better follow the process

- added descriptions of the conceptual steps, keeping them
  separate from specific instructions

- moved the specific instructions under a common heading to make
  the ToC more readable

* added explanations

- added link to GitHub docu on forks
- added note on philosophy followed
- improved ToC structure

* tried to finalize process description (see below)

- added airline-style "pay attention to the instructions" tip
- added bit about testing with Material for MkDocs documentation
  and examples from the examples repo
- added note on being respectful in discussion and on how sometimes
  PRs do not get accepted for good reason
- improvements for readability

* moved the "philosophy" bit to the steps

IMHO this is a better place to make this point as the comments are
mainly about what tools are used, which is more relevant to the
instructions, not the 30k ft view process

* added more text to steps guidance, dos and don'ts

- added more text to pretty much every section under 'steps'
- added a section with dos and don'ts
- left some questions for @squidfunk to ponder

* addressing first set of comments

* addressed further comments

In particular:
- removed the bits about linters and
- about dealing with merge conflicts

These may perhaps need attention in the future.

* removing question about PR template
2023-12-09 22:26:42 +01:00
squidfunk
31eafc9d4b
Updated Insiders changelog 2023-12-08 10:29:59 +01:00
squidfunk
63683eb3c5
Prepare 9.5.1 release 2023-12-08 09:39:09 +01:00
johnthagen
6c1859145a
Documentation (#6459) 2023-12-07 17:20:10 +01:00
Simon Marquis
9e9654d26b
Documentation (#6451)
Fixes #6450
2023-12-07 12:49:07 +01:00
squidfunk
eae02ad499
Updated changelog 2023-12-07 12:19:16 +01:00
squidfunk
39d390e330
Documentation 2023-12-07 12:04:43 +01:00
squidfunk
a8bd480c39
Prepare 9.5.0 release 2023-12-07 11:56:18 +01:00
Cvaniak
560bb9035d
Documentation (#6445) 2023-12-06 22:58:30 +01:00
Xiang ZHU
d363f903b8
Documentation (#6438) 2023-12-05 09:48:21 +01:00
squidfunk
0b38323a31
Updated dependencies 2023-12-04 11:06:25 +01:00
squidfunk
5cdd6147ba
Documentation 2023-11-30 13:30:31 +01:00
squidfunk
7b98080c77
Documentation 2023-11-30 13:27:01 +01:00