1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-18 18:36:07 +01:00
Commit Graph

2316 Commits

Author SHA1 Message Date
squidfunk
5bd843be23
Updated dependencies 2024-06-06 10:22:30 +01:00
Alexander Voss
2412a1b7bc
Documentation (#7221) 2024-05-29 08:08:02 +01:00
squidfunk
4a2cb488d6
Documentation 2024-05-28 12:32:15 +01:00
Alexander Voss
50d7c54bdf
Added blog and social cards tutorials (#7014)
* added tutorials page and blog tutorial

* proof reading, some language improvements

* split blog tutorial into parts

and reworked on the basis of comments, improved language, added missing
things

* + custom slugify function example

* +blog tutorial on engagement

* + section blog ToC

* + instructions for X/FB share buttons and started discussion system

* fix: module name `code` shadowed Python standard library module

* added What's next section

* +blog tutorial engagement part

* fix: updated Giscus code snippet

* trying multiple tutorials with headings for each group

* + basic social cards tutorial

* + custom social card tutorial

* + estimated time for custom card tutorial

* added tutorial sections to nav

* fixed typos, removed sponsor icon from level one heading

* removed "tutorial" from level one heading

* added headings to custom layout example

* fixed broken link

* fixes after run-through, added links to template repos

* added comment for @squidfunk

* clarified use of logos, some proof-reading

* removed question I left for @squidfunk

* clarified relationship between background color and image

* added override for the background image

* fixed wording and indentation

* changed example to be releases, not events

* being more specific where to add the last bit of code in the layout

---------

Co-authored-by: squidfunk <martin.donath@squidfunk.com>
2024-05-28 12:21:00 +01:00
squidfunk
c8ee11ff2b
Prepare 9.5.25 release 2024-05-27 11:37:06 +02:00
squidfunk
0ee1110643
Updated dependencies 2024-05-27 11:16:44 +02:00
squidfunk
09f817d154
Documentation 2024-05-25 09:18:07 +02:00
Kathi
86d3729a62
Created new and better Insiders documentation (#7210)
* Updated Insiders documentation

* Updated Insiders documentation
2024-05-24 14:44:35 +02:00
Alexander Voss
05af8988c8
Added --force-reinstall to insiders upgrade instructions (#7203) 2024-05-21 17:23:20 +02:00
squidfunk
7368c7f759
Updated Insiders changelog 2024-05-20 18:29:03 +02:00
squidfunk
e8478d921a
Documentation 2024-05-20 13:05:41 +02:00
squidfunk
721eefb076
Updated Insiders changelog 2024-05-20 12:58:58 +02:00
squidfunk
a5cc0691df
Prepare 9.5.24 release 2024-05-20 12:48:39 +02:00
squidfunk
72caddf8e3
Updated dependencies 2024-05-19 15:57:35 +02:00
squidfunk
f494840bd5
Documented for scope setting
Co-authored-by: Bizordec <25798995+Bizordec@users.noreply.github.com>
2024-05-15 17:48:44 +02:00
squidfunk
bb6c698c20
Prepare 9.5.23 release 2024-05-15 17:39:15 +02:00
squidfunk
3a27c8017e
Documentation 2024-05-15 17:35:32 +02:00
squidfunk
cc398ddc33
Added support for displaying version aliases 2024-05-15 17:24:40 +02:00
Vedran Miletić
d68db58553
Updated Cairo and pngquant installation instructions for Windows (#7163)
Instead of installing GTK+ and installing from source, suggested
installing MSYS2 and obtaining Cairo built for UCRT64 via its Pacman.
2024-05-14 17:02:25 +02:00
baseplate-admin
5872958127
Documentation (#7178)
* Update philosophy.md

* Update philosophy.md
2024-05-13 13:30:07 +02:00
squidfunk
b2b6571e7e
Prepare 9.5.22 release 2024-05-12 14:32:00 +02:00
Ilya Grigoriev
bd708f16bc
Documentation (#7166)
I found it difficult to find the instructions for setting up a
development environment with my usual GitHub habits. In fact, I assumed
they don't exist and missed the very helpful information.

I hope that this commit will help others find them.
2024-05-09 09:58:25 +02:00
Michael Vorburger
c1336ae0f5
Added missing validation/links/anchors to validation.json schema (#7158) 2024-05-06 15:52:50 +02:00
Matthias Schoettle
b1185aa4e9
Fixed JSON parse error in schema.json (#7152) 2024-05-06 09:05:43 +02:00
Dr. Vedran Miletić
0de8be26f8
Documentation (#6937)
This is consistent with how we fetch Mermaid.js and automatically picks
the latest minor version.
2024-05-05 11:47:08 +02:00
squidfunk
d1161b431f
Prepare 9.5.21 release 2024-05-03 19:06:22 +02:00
squidfunk
aef6175f04
Added type selection to icon and emoji search 2024-05-03 18:50:43 +02:00
Michael Vorburger
b0c5fe6aef
Updated JSON schema (#7150)
Since https://github.com/mkdocs/mkdocs/pull/92 for https://github.com/mkdocs/mkdocs/issues/91, an extra_javascript item does not necessarily have to end in *.js; e.g. in https://github.com/enola-dev/enola/pull/669 I have a extra_javascript: - https://unpkg.com/mustache@latest, which this flags up as wrong - although it's not (it works great); ergo it's better to remove this constraint.
2024-05-03 18:48:34 +02:00
squidfunk
5cb3117f50
Prepare 9.5.20 release 2024-04-29 16:49:02 +07:00
squidfunk
edcc5362fe
Documentation 2024-04-28 09:53:07 +07:00
squidfunk
2dd88aec48
Documentation 2024-04-28 09:52:23 +07:00
Alexander Voss
57d82dc253
Documentation (#7102) 2024-04-28 09:49:40 +07:00
Andre_601
400108301e
Documentation (#7112) 2024-04-28 09:49:06 +07:00
Alexander Voss
c427e1cb9f
Documentation (#7103)
* added note on importance of site_url

this was in response to
https://github.com/squidfunk/mkdocs-material/issues/4678#issuecomment-1327681673

* re-wording to say why site_url is always needed
2024-04-28 09:43:24 +07:00
Alexander Voss
9d901a3caf
Added note about additional navigation in footer, tags, blog (#7105)
in response to
https://github.com/squidfunk/mkdocs-material/discussions/6995#discussioncomment-8960916
2024-04-26 16:42:32 +07:00
squidfunk
222d9e1b19
Updated Insiders changelog 2024-04-26 11:29:53 +07:00
squidfunk
2e1e109c4a
Updated Insiders changelog 2024-04-25 11:27:10 +07:00
squidfunk
0a39f04cea
Prepare 9.5.19 release 2024-04-25 11:07:01 +07:00
squidfunk
2585b82be2
Fixed all anchors after turning on validation 2024-04-25 10:51:05 +07:00
squidfunk
374bbab9d3
Updated dependencies 2024-04-25 09:37:50 +07:00
johnthagen
dca9c27417
Documentation (#7092) 2024-04-24 21:03:58 +07:00
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