1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-13 16:21:14 +01:00
Commit Graph

2177 Commits

Author SHA1 Message Date
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
squidfunk
358ba513bb
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2023-11-30 13:05:23 +01:00
squidfunk
b96f2409c4
Added blog post on new badge 2023-11-30 13:05:15 +01:00
katharinalisalin
9d2bbbc649 Removed Support for Ko-Fi 2023-11-29 13:10:33 +01:00
squidfunk
d0a536acc2
Documentation 2023-11-29 10:10:46 +01:00
squidfunk
fd90fa6518
Updated Insiders changelog 2023-11-26 17:03:41 +01:00
squidfunk
c0aca21360
Prepare 9.4.14 release 2023-11-26 16:56:52 +01:00
squidfunk
989ee849bb
Documentation 2023-11-26 16:53:51 +01:00
squidfunk
8b68710ea3
Documentation 2023-11-26 16:10:29 +01:00
squidfunk
d355b435a7
Documentation 2023-11-26 15:46:58 +01:00
squidfunk
c81befb4ec
Updated JSON schema 2023-11-26 15:33:54 +01:00
squidfunk
6be485c38f
Documentation 2023-11-26 15:22:43 +01:00
squidfunk
28ebcbfb59
Added support for linking authors in blog posts
Co-authored-by: alexvoss <4134224+alexvoss@users.noreply.github.com>
2023-11-26 14:29:38 +01:00
squidfunk
9c01605149
Updated dependencies 2023-11-26 13:09:17 +01:00
squidfunk
baaac7c291
Prepare 9.4.13 release 2023-11-26 13:06:48 +01:00
Martin Donath
8143abe1e8
Documentation
Update setting-up-tags.md
2023-11-26 13:03:13 +01:00
squidfunk
bf6e66bddd
Prepare 9.4.12 release 2023-11-24 10:47:24 +01:00
squidfunk
772e159664
Switched tags plugin to generate Unicode-aware slugs 2023-11-24 09:50:38 +01:00
squidfunk
d43626a838
Switched blog plugin to generate Unicode-aware slugs 2023-11-24 09:06:36 +01:00
squidfunk
ae364f82af
Documentation 2023-11-23 19:07:37 +01:00
squidfunk
3804998090
Documentation 2023-11-23 13:08:59 +01:00
squidfunk
c97133e38f
Updated Insiders changelog 2023-11-23 12:25:43 +01:00
squidfunk
697116f6af
Prepare 9.4.11 release 2023-11-23 12:12:44 +01:00
squidfunk
8053524ad8
Prepare 9.4.11 release 2023-11-23 12:12:19 +01:00
squidfunk
0fd2a3940e
Added documentation on new advanced blog settings 2023-11-23 11:41:19 +01:00
squidfunk
a6772cf5e8
Added documentation on new advanced blog settings 2023-11-23 11:26:05 +01:00
Adrian Rumpold
3d76c89483 Replace Neoteroi markdown extensions schema with external URL 2023-11-22 08:03:04 +01:00
Adrian Rumpold
6b3accd2a7 Add mkdocs.yml JSON schema support for sane_lists and Neoteroi markdown extensions 2023-11-21 16:01:30 +01:00
squidfunk
5fd86bd670
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2023-11-21 08:37:54 +01:00
squidfunk
4edce43497
Added note on sponsors to plugins 2023-11-21 08:37:48 +01:00
Sigurd Spieckermann
b0680bd6e2 Replaced enum by const for constant value types in schemas 2023-11-20 20:21:18 +01:00
Letian W
d8847e002c
Update setting-up-tags.md
Settings in mkdocs.yml need to be configured for tags.md to be recognized.
2023-11-20 12:30:56 -05:00
squidfunk
258e1dfcd3
Documentation 2023-11-19 11:57:39 +01:00
squidfunk
09e250b03b
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2023-11-19 11:35:02 +01:00
squidfunk
bafa78094d
Updated dependencies 2023-11-19 11:33:02 +01:00
Martin Donath
17f6edb6d4
Merge pull request #6355 from katharinalisalin/docs/community-experts
Added documentation on community experts
2023-11-19 11:32:20 +01:00
squidfunk
71a87f86b4
Prepare 9.4.10 release 2023-11-19 11:17:31 +01:00
Sigurd Spieckermann
f528598540 Dropped schema for Google Universal Analytics 2023-11-19 10:11:19 +01:00
Sigurd Spieckermann
09cfb90a0e Fixed extra:analytics schema for custom providers 2023-11-19 10:04:08 +01:00
katharinalisalin
61c7f6fb41 Documentation 2023-11-17 13:02:11 +01:00
squidfunk
a2a4dd928a
Prepare 9.4.9 release 2023-11-17 12:19:55 +01:00
squidfunk
37b57d5712
Documentation 2023-11-17 11:44:29 +01:00
Martin Donath
fc07e0a557
Merge pull request #6347 from sisp/docs/vscode-custom-tag-relative
Add custom tag `!relative` to VS Code settings docs
2023-11-17 09:58:41 +01:00
Kathi
86c76c4461
Documentation (#6342)
* Merge

* Deleted Community Ambassadors

* Updated faq list
2023-11-17 09:44:25 +01:00
squidfunk
283938a5b5
Documentation 2023-11-17 09:43:30 +01:00
Kathi
76d26fe756
Documentation (#6341)
* Merge

* Deleted Community Ambassadors

* Updated Enterprise Support Page
2023-11-17 09:42:10 +01:00
Sigurd Spieckermann
6cc974a385 Documentation 2023-11-16 10:21:46 +01:00
Couleur
c7f927bc4e
Documentation (#6331) 2023-11-14 23:04:58 +01:00
James Ding
142573fc0c
Updated publishing-your-site.md (#6335) 2023-11-14 23:01:25 +01:00
squidfunk
88470b38cd
Added monochrome logo to icons 2023-11-14 09:37:59 +01:00
squidfunk
830011eb1c
Updated dependencies 2023-11-12 16:18:13 +01:00
Sigurd Spieckermann
ec86acbce3
Added type property to theme:font schema to support font: false (#6317) 2023-11-12 15:40:34 +01:00
squidfunk
1e313416e3
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2023-11-09 16:57:00 +01:00
squidfunk
62de852ce8
Added Trendpop to Silver sponsors 2023-11-09 16:56:54 +01:00
Alexander Voss
06ef698ab2
Documentation (#6311) 2023-11-07 20:23:15 +01:00
Rafał
40a042e405
Documentation (#6305) 2023-11-07 11:44:29 +01:00
Andre_601
2d66c32ba7
Add link for Codeberg Pages guide 2023-11-06 13:47:51 +01:00
squidfunk
c0755bf247
Prepare 9.4.8 release 2023-11-05 19:50:30 +01:00
squidfunk
fabc9bd6b8
Documentation 2023-11-04 08:37:31 +01:00
Alexander Voss
9a7a185f9d
Documentation (#6267)
* added short description + links to MkDocs docu

* hopefully better wording
2023-11-02 11:52:33 +01:00
Letian W
7353c7d7cf
Documentation (#6277)
KaTeX also needs Arithmatex to prevent conflict with the markdown parser.
2023-11-02 11:52:10 +01:00
eleanor-arc-boats
1698708b23
Documentation (#6260)
* Update reporting-a-bug.md

fix discussion board link

* space
2023-10-30 21:45:13 +01:00
Sigurd Spieckermann
551d98e6de
Documentation (#6222) 2023-10-30 21:14:42 +01:00
squidfunk
ff76068e41
Prepare 9.4.7 release 2023-10-27 19:15:44 +02:00
squidfunk
525fc94cd3
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2023-10-27 13:19:10 +02:00
squidfunk
92ef0e2804
Updated Premium sponsors 2023-10-27 13:19:02 +02:00
Alexander Voss
8feb512267
fixed typo: "hosting" -> "hoisting" (#6244) 2023-10-25 21:04:53 +02:00
squidfunk
565a5e804b
Updated dependencies 2023-10-25 17:54:59 +02:00
Sigurd Spieckermann
874b9dbf1d
Documentation (#6239) 2023-10-24 12:11:41 +02:00
squidfunk
0341516fe5
Updated dependencies 2023-10-23 16:50:25 +02:00
Sigurd Spieckermann
ee9f1f4952
Specify container image in GitLab CI job instead of globally (#6224) 2023-10-23 09:32:24 +02:00
Alexander Voss
371ed7744c
Documentation (#6220) 2023-10-21 13:04:26 +02:00
squidfunk
cfd1b6c4ef
Documentation 2023-10-18 18:44:17 +02:00
squidfunk
ee0a3c6ed2
Documentation 2023-10-18 17:14:53 +02:00
squidfunk
2f071fdb9a
Documentation 2023-10-16 18:36:10 +02:00
squidfunk
f6fd27240c
Documentation 2023-10-16 18:35:09 +02:00
Alexander Voss
6a9b685405
Documentation (#6200)
* vim backup files to be ignored

* added tip about using document$ observable
2023-10-16 16:25:29 +02:00
Robin Genz
e2fc46a299
Documentation (#6202) 2023-10-16 16:23:49 +02:00
squidfunk
5c318799f6
Updated dependencies 2023-10-16 11:20:58 +02:00
squidfunk
2742a707cc
Updated Insiders changelog 2023-10-14 10:48:18 +02:00
squidfunk
1990b21c82
Prepare 9.4.6 release 2023-10-14 10:46:00 +02:00
Sigurd Spieckermann
39e1251ef2
Install extras from local package for development environment setup (#6189) 2023-10-14 09:09:13 +02:00
Sigurd Spieckermann
c3683b240f
Escaped snippet syntax in code block example (#6183) 2023-10-13 08:26:24 +02:00
squidfunk
fe69addc28
Prepare 9.4.5 release 2023-10-10 10:31:36 +02:00
squidfunk
4ba4e5c084
Updated dependencies 2023-10-09 08:50:56 +02:00
Alexander Voss
8622ea6381
Updated JSON schema (#6146)
* added missing "unrecognized_links"

* changed "definitions" to "$defs"

"$defs" is where people would expect definitions of
reusable subschemas to live
2023-10-06 09:53:01 +02:00
Alexander Voss
27a1e7c3ee
Added new MkDocs 1.5 settings to JSON schema
* added support for two new entries in mkdocs.yml

`exclude_docs` and `not_in_nav` were introduced in MkDocs Version 1.5

* added support for the validation field

* using $defs, supporting simplified form, no additional props

- this should support the forms of definitions described in the manual
  https://www.mkdocs.org/user-guide/configuration/#validation
  including uses with `nav` and `link` sections as well as without
- making use of a `$defs` section to avoid too much duplication
- added `"additionalProperties": false`

* moved `additionalProperties` for consistency with style
2023-10-05 19:16:54 +02:00
squidfunk
27b0d1d08c
Added (custom) page status example 2023-10-05 19:12:18 +02:00
squidfunk
cffbc171a0
Documentation 2023-10-05 18:15:29 +02:00
squidfunk
fc62b35421
Updated Insiders changelog 2023-10-05 18:07:37 +02:00
squidfunk
59d21ffe6f
Prepare 9.4.4 release 2023-10-05 18:05:40 +02:00
squidfunk
a9da0b632c
Added support for specifying copied text for code blocks 2023-10-05 17:51:50 +02:00
Alexander Voss
6990976793
Updated theme setup documentation (#6125)
* added instructions for working on Insiders

also added a note about how to prevent installing things outside a venv,
which I hope will be useful to people

* fixed broken link

* incorporated changes suggested by @squidfunk

- clarified language about access to Insiders
- let's not suggest SSH access
- better heading for note on getting pip to work in venv only

* added annotation that mentions cloning with ssh

* fixed indent
2023-10-03 17:33:25 +02:00
Simon Marquis
5ba794405f
Fixed link to projects plugin (#6127) 2023-10-03 16:13:01 +02:00
squidfunk
b197c9ede3
Updated latest blog post 2023-10-02 23:16:31 +02:00
squidfunk
4e72aa08cd
Updated JSON schema 2023-10-02 23:14:08 +02:00
squidfunk
c928e03fa8
Merge branch 'master' of github.com:squidfunk/mkdocs-material 2023-10-02 15:07:43 +02:00
squidfunk
a126d9e1f4
Added blog post on sunsetting Gitter 2023-10-02 15:07:36 +02:00
Alexander Voss
f35a276825
Added note on offline usage in getting started guide (#6116) 2023-10-02 14:31:10 +02:00