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

309 Commits

Author SHA1 Message Date
Christian Oliff
b45c51dee4
Changed Twitter to X (#7266)
Updates the icon and saves a HTTP redirect too
2024-06-13 09:57:02 +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
Kathi
86d3729a62
Created new and better Insiders documentation (#7210)
* Updated Insiders documentation

* Updated Insiders documentation
2024-05-24 14:44:35 +02:00
katharinalisalin
14b0b06e68 Moved contribution guides to community section 2024-03-08 13:55:38 +07:00
squidfunk
672414163c
Documentation 2024-01-24 15:45:24 +07:00
squidfunk
7624e78744
Updated copyright year 2024-01-06 09:27:06 +07: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
f855a67384
Merged features tied to 'Goat's Horn' funding goal 2023-12-07 10:48:42 +01:00
katharinalisalin
61c7f6fb41 Documentation 2023-11-17 13:02:11 +01:00
squidfunk
37b57d5712
Documentation 2023-11-17 11:44:29 +01:00
Kathi
86c76c4461
Documentation (#6342)
* Merge

* Deleted Community Ambassadors

* Updated faq list
2023-11-17 09:44:25 +01:00
squidfunk
f8fd537b97
Added support for instant navigation progress indicator 2023-10-01 09:42:02 +02:00
Alexander Voss
0c498b4345
added instructions for checking out and updating specific releases (#6095)
* added instructions for checking out specific releases and also moved the bit about $GH_TOKEN to a place above
the pip install instructions
* separated out update instructions, revised git instructions
* bumped version number that insiders is based on
* removed --upgrade from update command
* made insiders changelog a section
* changed instructions for upgrading via git
2023-09-28 10:42:28 -04:00
squidfunk
859b8bcaee
Improved slate color scheme 2023-09-21 17:23:36 +02:00
squidfunk
98569eb23d
Removed typeset plugin from mkdocs.yml 2023-09-21 15:02:37 +02:00
squidfunk
c476842334
Merge branch 'master' into docs/guides 2023-09-21 14:53:33 +02:00
squidfunk
00c5fb1766
Added emoji extension 2023-09-20 17:33:29 +02:00
squidfunk
56b96b4d79
Restructured project 2023-09-20 13:58:03 +02:00
Martin Donath
cd008fdf29
Restructured documentation (#5692) 2023-09-14 19:09:18 +02:00
squidfunk
2a131caad6
Documentation 2023-09-10 08:19:21 +02:00
squidfunk
de0c5b7719
Documentation 2023-08-27 14:21:15 +02:00
squidfunk
04bde62c91
Added support for adding update dates to blog posts 2023-08-01 19:10:11 +02:00
squidfunk
18cac39370
Updated JSON schema 2023-07-07 11:22:30 +02:00
squidfunk
e0a25678c4
Added sponsoring FAQs 2023-06-29 16:28:58 +02:00
katharinalisalin
8a4e0e294b Added faq list 2023-06-02 13:38:55 +02:00
katharinalisalin
a154c64028 Merge branch 'master' into docs/math 2023-05-23 11:28:04 +02:00
Anurag Dhadse
c1948b22ea moved katex documentation to math.md 2023-05-13 17:04:57 +05:30
squidfunk
2735c87d9a
Finished documentation on social cards 2023-05-08 16:44:39 +02:00
Anurag Dhadse
3bd214fce6 added katex documentation 2023-04-29 19:24:30 +05:30
katharinalisalin
4586c0fc07 Added setup index.md 2023-04-06 15:03:41 +02:00
katharinalisalin
268c5066ba Updated guides 2023-04-04 14:58:40 +02:00
squidfunk
9b581ae19e Fixed occasional flickering of dismissed announcement bar 2023-02-26 19:00:56 +01:00
squidfunk
3cc6e4aec8 Documentation 2023-02-19 17:34:18 +01:00
squidfunk
3fc8b6be8b Added Mastodon verification for social links 2023-02-03 17:33:28 +01:00
squidfunk
87fed7ec2e Updated documentation and change request template 2023-01-29 19:14:23 +01:00
squidfunk
d32ca846f1 Added hook to automatically compute and update translations 2023-01-28 20:18:09 +01:00
squidfunk
57a9ed8bab Added guide on installing image processing dependencies 2023-01-21 17:51:17 +01:00
squidfunk
ee703e6be4 Added documentation for built-in optimize plugin 2023-01-21 17:03:55 +01:00
squidfunk
3311c82cb5 Removed old redirects 2023-01-02 14:13:07 +01:00
squidfunk
3b921f76a3 Updated copyright year 2023-01-02 11:08:58 +01:00
squidfunk
d25326fc52 Updated site description in mkdocs.yml 2023-01-02 11:06:48 +01:00
squidfunk
e63cd5a55a Finished first version of bug report guide 2023-01-01 17:22:03 +01:00
squidfunk
3a3ae932c3 Added first part of new bug reporting guide 2022-12-31 18:28:19 +01:00
squidfunk
5421abee16 Reworked search documentation 2022-12-31 14:57:05 +01:00
squidfunk
28d64a289a Added view source button 2022-12-11 18:32:22 +01:00
squidfunk
b3d2b7baaa Removed unnecessary search separator 2022-12-07 11:12:35 +01:00
squidfunk
b550b1a532 Merged features tied to Carolina Reaper funding goal 2022-12-07 11:11:02 +01:00
squidfunk
8fdd1ad529 Added support for disabling footer navigation 2022-11-12 14:44:59 +01:00
squidfunk
128e26742c Added support for removing copy-to-clipboard button 2022-11-12 14:32:13 +01:00
squidfunk
6a1b86e8c6 Fixed development environment and overrides 2022-11-11 18:39:38 +01:00