Founder of @zensical, creator of Material for MkDocs
- Tweets 4,594
- Following 211
- Followers 4,246
- Likes 4,010
Pinned Tweet
Very proud of the team today: we’re launching @Zensical Studio. 👏
A lot of work went into making this fast, precise, and useful in real documentation projects. If you write docs with Zensical or MkDocs, we'd love your feedback!
Today, we're launching Zensical Studio, the missing productivity layer for Docs-as-Code. The idea is simple: Refactor documentation like code. Rename headings safely. Catch [broken links] instantly.
Works with Zensical and MkDocs projects. zensical.org/studio/
6
535
🤯 @AWSOpen just sponsored Material for MkDocs! The AWS Open Source Software Fund donated $10k to the project!
We've started building a small but amazing team around the project and contributions like this help us sustain our efforts pushing the project to new heights!
❤️❤️❤️
17
29
360
31,862
Material for MkDocs just hit $ 100k/year 😱
That's absolutely unbelievable. I think it's safe to say that with product-market fit and a well-designed release strategy, it's possible to earn a living in Open Source. 1/🧵
18
16
227
TIL you can view Node CPU profiles in Visual Studio Code 😱
1. Run node --cpu-prof file.js
2. Open *.cpuprofile in VS Code
There you go:
6
42
180
🥳 Material for MkDocs reached its next funding goal! Thanks to our awesome sponsors, the following features will now be free as part of our community edition:
✏️ Blog plugin
🇨🇳 Chinese search support
⭕️ Annotations
🧭 Navigation icons
✂️ Navigation pruning
🤨 Navigation status
9
18
149
23,830
We're super proud to welcome @FastAPI by the wonderful @tiangolo as the first silver sponsor of Material for MkDocs! FastAPI is an amazing Python framework to build lightning fast APIs with a world-class developer experience!
fastapi.tiangolo.com/
1
12
143
24,038
Bloomberg just gave a $10k grant to MkDocs!
We're also announcing the Q2 2023 @Bloomberg #FOSS Fund grant recipients:
-- @MkDocsProject
-- #OpenSSH
-- @PostgreSQL
Congratulations!! Each of these #opensource projects has received a $10K grant to support the people & communities who maintain them
#MkDocs #Postgres
7
7
122
12,674
🥳 Material for MkDocs is one of the winners of Google's Open Source Peer Bonus Program 2023
opensource.googleblog.com/20…
10
9
117
10,778
2022 has been an incredible year for Material for MkDocs. We increased our monthly funding from $4k to over $10k, and growth is still looking insane. I'm so glad that I'm allowed to work on something that I personally believe in, building something I think is important.
1/🧵
3
5
103
18,547
🎊 Important milestone: $10k/month
Material for MkDocs just reached $10k/month in sponsorships! This means the new 🔍 search will be released into the community edition, including better offline support. Expect a beta release in the coming days!
squidfunk.github.io/mkdocs-m…
7
5
101
🎉 Material for MkDocs has a new landing page!
I'm super excited to finally reveal the results of the past weeks of hard work, check it out here:
squidfunk.github.io/mkdocs-m…
A thread 🧵 1/5
9
10
93
Thanks to my awesome sponsors, I'm all bootstrapped – no investors to please. I can just write useful software every day, trying hard to make the lives of thousands of other individuals easier and more joyful. Life is great ❤️
7
3
91
5,590
Material for MkDocs just got sponsored by @SIEMENS 😎 I'm super happy to see more huge international organizations understand the value of Open Source and support it financially. Funding allows us to stay on top of our game!
6
8
91
5,731
It's quite astonishing to see the impact of the Insiders program on Material for MkDocs. New releases are pushed out far more regularly and at a faster pace.
Instant bug fixes, more new features – this is what Open Source with funding can look like. That simple. 🤟
5
7
89
🥳 We've reached our next funding goal! It's amazing how many individuals and companies see value in my work and support it financially, so I can continue trying to make writing documentation joyful for all of us.
Thread 1/🧵
8
5
95
15,941
🤩 I'm speechless! The $5,000 monthly funding goal was just reached! A BIG THANK YOU to all my awesome sponsors! You are the reason why I can push this project forward! Coming up in 8.2:
– Mermaid.js integration
– Built-in tags support
– Stay on page when switching versions
5
2
78
I'm making progress on native blog support. The left sidebar will host author info, reading time, linked releases, and links to related articles and pages 🚀
Still heavily WIP.
10
6
77
Sneak peek: code block annotations – coming soon to Material for MkDocs Insiders. Code block annotations can contain _any_ valid Markdown and can be placed _anywhere_ inside code blocks.
7
8
80
What an honor! The official WebKit documentation is now built with Material for MkDocs 🤯
docs.webkit.org/
2
4
69
6,778
Announcing ⚡️ Instant previews
This is the next big thing coming to Material for MkDocs. I was already teasing that some exciting new features are in the pipeline and here's the first sneak peek of what's about to hit the shelves in the coming weeks.
A thread 👇 1/
8
7
67
Material for MkDocs hits its 400th release! 🎊 It's only a minor bugfix release, as most releases, but it shows our commitment to keep things fresh and up-to-date 😎
github.com/squidfunk/mkdocs-…
1
67
1,453
📣 Announcing blog support
Insiders 4.23.0 ships long-awaited blogging support via the brand new built-in blog plugin! 🚀 All sponsors can now build a blog using Material for MkDocs!
Check out our new blog to see it in action:
squidfunk.github.io/mkdocs-m…
This is how it looks:
1
12
65
Woah, it looks like @arxiv is switching its docs portal to Material for MkDocs 😱 What an honor!
docs.arxiv.org/
2
9
62
I just wrote a comment on GitHub that took me 40mins to write. Open Source is as much about writing code as it is about good communication ✌️
1
7
60
3,449
🆕 IntelliSense for mkdocs.yml
I've put together a JSON schema definition for the mkdocs.yml syntax expected by Material for MkDocs, which enables auto-complete and validation. Writing config has never been easier!
Set it up in 5 minutes:
squidfunk.github.io/mkdocs-m…
4
4
63
Blog support for Material for MkDocs is coming on Monday. I'm going to finish the docs on the weekend, so everything should be ready by Monday.
Really looking forward to this! Definitely the biggest release this year. As always, all sponsors will be able to use it immediately 🚀
1
3
63
🎉 Material for MkDocs 8 is out!
I'm super happy with the result – code annotations now work beautifully on mobile and tablet, the code base has undergone a serious refactor and the project is in better shape than ever. It's rock-solid.
Release notes:
squidfunk.github.io/mkdocs-m…
4
10
52
🤫 I'm working on an exciting new plugin which automatically optimizes all 🖼 images it finds in your documentation. It does so concurrently (which yields much faster builds) and caches results, so optimizations are never performed twice, unless necessary.
6
1
55
11,453
Open Source is brutal. Making a living on your own is hard – even harder when most of your users expect you to work for free. However, if you believe in your project and build something of value, the freedom that comes with it is worth everything you went through.
3
2
57
8,359
– Material for MkDocs Live Edit –
A POC I just threw together running the Material for MkDocs stack in the browser. Much, much faster than MkDocs dev server, and no need to install anything!
7
3
61
What a day! The blog plugin saw the light of day and now the next funding goal was hit! 🎊 Wow! 🤩 Again, a huge thank you to all my awesome sponsors for supporting my work on Material for MkDocs!
You rock! 🤟
1
4
56
🤯 I'm speechless! 7 weeks after reaching the last funding goal, here we go again! A HUGE THANK YOU to my awesome sponsors! 🙏 Without you, Material for MkDocs wouldn't be the go-to solution for technical documentation that it is today.
New major release incoming 🎉
5
1
58
Finished the blog post view – pretty happy how it turned out! You can use nav syntax in blog posts to provide the user with related links, and those can even contain anchors which are automatically resolved and rendered as subtitles. How cool is that?
Check it out:
4
2
57
Material for MkDocs turned 8 two days ago 🥳
github.com/squidfunk/mkdocs-…
2
9
59
3,332
The search engine I'm currently building for Material for MkDocs will be so flexible, you can swap out basically everything. I think it's going to be the most modular thing I've ever built, and will be one of the fastest engines around 😎
2
4
54
7,927
Open Source Maintainer Life
You take one day off – 30 things happened on GitHub, 5 new issues, several new PRs. Oh man, don't let a day slip by, clean up often or you will lose the battle. Procrastination is not something you can afford on a popular project 😅
3
4
56
6,356
😍 The @PyPI blog is now powered by Material for MkDocs! I couldn't be more proud! Note that the PyPI blog doesn't use our official built-in blog plugin, but a third-party plugin instead.
blog.pypi.org/posts/2023-03-…
4
4
56
6,395
Congrats to the first 1,000 GitHub stars for MkDocStrings, @pawamoy! The project's currently growing fast and might eat Sphinx's lunch in the future😁
github.com/mkdocstrings/mkdo…
3
3
55
❄️ Cold times are approaching, let it snow!
With Christmas around the corner, there's a temporary new hidden feature in Material for MkDocs 🤫 You can see it live on our documentation! Want to unlock it to add it to your own documentation as well? Read on!
1/🧵
11
3
53
📣 New blog post: the past, present and future of Material for MkDocs:
– the very first version in 2016 (it looked so ugly!)
– features released in 2021 (SO MANY 😱)
– funding situation compared to 2020
Check it out here:
squidfunk.github.io/mkdocs-m…
4
13
53
🤗 We are very close to our next funding goal! Once this goal is reached, the following features will become free for everybody to use:
– Privacy plugin
– Card grids
– Tooltips
– Linkable content tabs
– Automatic light/dark mode
– Document contributors
github.com/sponsors/squidfun…
2
8
54
11,230
Netflix is killing it! This must be one of the most beautiful Material for MkDocs mods I've seen so far 😍
netflix.github.io/dgs/
3
10
53
Material for MkDocs 7.3.6 brings another much-requested feature – code block titles ✍️🤓
squidfunk.github.io/mkdocs-m…
1
48
When I got into this business, nobody told me that my job description would be 'technical writer' for quite a significant fraction of my time. I guess that's also included with 'full-stack engineer'.
6
3
51
The documentation of the European Open Data Portal is now running on MkDocs and Material for MkDocs 😍 @EU_opendata @ondatait
dataeuropa.gitlab.io/data-pr…
8
48
4,768
I've started building a repository with runnable examples for all features that Material for MkDocs supports. This will be an ongoing effort, but will make bootstrapping projects easier for users.
You can star and watch it here:
github.com/mkdocs-material/e…
2
53
📣 New blog post: How we're transforming Material for MkDocs
We know it's been quite a while since our last update, which is why we're eager to share what's happening in and around Material for MkDocs with you.
squidfunk.github.io/mkdocs-m…
2
4
53
2,420
Sandbox: 250/month – FREE – "Great for building a proof of concept, evaluating capabilities and functionality, and limited scale exploration of the last month of Tweets, instantly."
One little mistake and you have to wait for 30 days to continue working on your integration 😂
3
46
12,783
🤩 Woah, I'm speechless! @elastic is now a premium sponsor of Material for MkDocs! They really don't need an introduction, so they're not going to get one 😉
elastic.co
❤️❤️❤️
2
47
Wednesday, I had a call with one of our commercial users. They said that thanks to the SEO best practices Material for MkDocs follows, their documentation now has 1M monthly hits – more than their main website 😎
Best thing: it comes for free – it's all static HTML!
3
3
50
4,128
For almost two years, I've wanted to build a new landing page for Material for MkDocs, and I'm super excited to say that after weeks and weeks it's almost finished! It will feature a jaw-dropping illustration done by my sister.
3
45
We listened to the feedback of our many users, and rebranded Material for MkDocs from being "just a theme for MkDocs" to:
A powerful documentation framework built on top of MkDocs
We think this better reflects the capabilities it offers 🚀
1
46
2,791
Ah, yeah. Open Source. Our highest maintenance user (not a sponsor) that binds so much of our time, complains a lot, and to whom we provided free support in countless situations in the past now starts calling our solutions stupid. Good job, mate! That's the spirit.
7
48
6,771
I'm pretty excited that @CERN uses my project Material for MkDocs for their documentation! At the end of my studies, I applied for writing my Diploma thesis at CERN on some computing topic – I wasn't accepted. Glad I still found a way to make an impact.
abpcomputing.web.cern.ch/
1
40
Today, I had a very nice and insightful call with two devs from a large corporation that uses Material for MkDocs for their internal documentation, and learned that they use it in 2,000 projects 🤯
That's, by far, the widest use I've ever seen.
1
2
48
3,739
🎊 Material for MkDocs 9 is out!
It comes with a new search implementation which is faster, generates smaller search indexes and supports HTML formatting ✏️ If you haven't used it yet, read our blog article to learn more!
Also, try it on our docs! 🔍
squidfunk.github.io/mkdocs-m…
2
6
45
6,008
Docs are shaping up – adding a "How it works" and "When to use it" section to the new documentation section that describes all built-in plugins 😎
1
3
42
6,080
Imagine you create something, offer it for free, thousands of people start using it, and demand more and more and more. That's what maintaining a large project with thousands of users feels like.
If a project helps you save time, pay the maintainers.
Be fair. Don't freeload.
1
2
39
The blog plugin is probably the most flexible plugin I wrote so far. In the process, I learned so much about the internals of MkDocs, that I can probably call myself an expert by now.
Of course, you don't need to specify all of this – those are just the defaults. 😎
2
1
44
Material for MkDocs is featured in @GitHub's November's Release Radar on the GitHub Blog – what an honor! 🥳
github.blog/2021-12-03-relea…
2
2
39
The new social plugin is done! It's infinitely more powerful, and allows for live editing via simple 'mkdocs serve' 🚀 Check out what you can throw together in 10 minutes. The only thing I still need to do: write documentation 😎
5
1
41
4,753
Material for MkDocs is now at over 2 million downloads a month 🤯
pypistats.org/packages/mkdoc…
2
1
40
4,374
Open Source funding got a dent in 2023 – I actually would've expected its growth to continue, but it didn't. All Open Source projects on Open Collective combined raised $16M ($19M in 2022) in 2023. We need more organizations supporting OSS!
discover.opencollective.com/
6
7
40
4,562
Woah! We just reached the $7,000 funding goal 1 hour before I planned on closing my laptop and disappearing into my holidays 😅🙏
I want to thank all my awesome sponsors for making my work on this project possible! You are helping in removing the suck from writing documentation!
2
1
41
More than half of all Cloud infrastructure related blog posts are on Medium and after working for 30min you're paywalled. That sucks, and it's a great motivator to make the Material for MkDocs blog plugin even better.
1
2
36
3,176
Material for MkDocs 9 will be released in 4 days, on January 2, 2023. It's finished since about a week, but releasing something over Christmas or NYE is likely not the best idea 🙉
2
42
3,689
Instant previews are finally happening! 🚀
After finishing the new footnote tooltips positioning logic, I've started working on instant previews, which render internal links to sections in a tooltip as well. Of course, this will be opt in. Here's what I've got already:
6
4
41
5,196
I have a two year old MacBook Pro and everything I use (apps, websites) is getting slower and slower. When did most of us stop carrying about snappiness? My god, we have so much power on our hands, why is most software out there so crappily written? 💩💩💩
13
3
38
8,906
🏷 Tag support for Material for MkDocs – it's done!
Insiders 2.7.0 adds support for tags (including a browseable tags index and search integration), which means users of Insiders can start using it NOW 🚀
Docs:
squidfunk.github.io/mkdocs-m…
Get Insiders:
squidfunk.github.io/mkdocs-m…
1
4
39
🙋♂️ I'm working hard on the new search which is going to be much more powerful soon. It'll be possible to index custom metadata (e.g. document authors) to filter documents and the relevance of results will be much better. Here's a sneak peak of a prototype.
2
3
38
7,212
Always funny when I search for the docs of a project for the first time and stumble across a site made with Material for MkDocs. Full circle. This time: AWS Lambda Powertools for TypeScript
awslabs.github.io/aws-lambda…
5
3
37
3,734
Social cards are shaping up! The next update will be a game changer, adding support for backgrounds, tints, Jinja templates for rendering content, adding metadata and so much more... This was a lot of hard work to get going, so give it a few more days! It'll be worth it 😎
7
2
36
5,144
We're currently investing a lot of time into restructuring our documentation to account for the increasing number of options that Material for MkDocs and especially its unique built-in plugins include.
1
1
37
2,946
What a day! First time on Hackernews' front page:
+12k sessions
+36k page views
+180 stars on GitHub
... and counting.
3
1
38
I'm really looking forward to the next funding goal being hit soon, as this means the blog plugin will be released into the wild. I'm not sure what will happen, but IMHO it's by far one of the most complete OSS solutions for technical blogging – massive batteries included.
2
36
2,500
Tomorrow is a big day – we will unveil our new bug reporting process. This is a hell of a huge experiment and has been in the making for weeks. It should be much easier to report bugs now, and there's a whole new section on the documentation 🚀
Oh, and of course Material 9 😎
1
1
36
4,434
Spotted a very nice mod of Material for MkDocs by the Ministry of Justice (UK). Few users know, that with a little knowledge of CSS, you can completely change the look of the theme!
ministryofjustice.github.io/…
1
1
33
3,963
I really can't wait for code annotations to be generally available! They have the potential to transform the way we document code examples, allowing for rich text (incl. images, graphs, tables, etc.) to be co-located with code.
squidfunk.github.io/mkdocs-m…
3
34
To those of you waiting for the blog feature – I'm working hard on it whenever I can. Flexibility and ease of use are very complex to unite, but possible. Once the blog plugin comes out, there should be no more reason to use another framework for adding a blog to your docs.
3
1
36
Current iteration of the blog overview page. Blog articles marked as drafts are rendered on serve, but removed from the output when the site is built. While all pages on the left are auto-generated from blog posts, authors can also add custom pages.
3
4
34
Just discovered that @Google started adopting Material for MkDocs for their Open Source projects, which is funny, as they practically created Material Design - the underlying design language.
I guess I can consider this a success ☺️
google.github.io/xls/
3
34
🤫 Few people know: Material for MkDocs is very adaptable and can be skinned with ease. I just threw this together in 20m:
2
4
34
Looks like @Blender is moving to Material for MkDocs 😎
code.blender.org/2023/12/a-n…
3
37
1,586
9.5.5 is a big, big bugfix release – all known bugs of instant navigation should now be resolved, as I did a thorough rewrite, plus it should be much more resilient. Moreover there are now more inline comments to explain how it works than lines of code 😅
github.com/squidfunk/mkdocs-…
1
4
35
1,605
I finally cracked the hardest problem on the blog plugin – auto-generating pages with dynamic URLs (archive, category pages, etc.). It sounds so simple, but making this all work with MkDocs is quite a challenge! Woah!
4
4
34
1/ Material for MkDocs turned 5 this February. I wrote about my experience maintaining it:
github.com/squidfunk/mkdocs-…
2
3
34
🆕 in the docs – 🕵️♀️ icon-search 🚀
Find the perfect icon to use in your Markdown document quickly and copy the shortcode with one click. All set.
Check it out here:
squidfunk.github.io/mkdocs-m…
3
6
34
> "When is feature X ready? Our company needs it now!"
< "Have you considered sponsoring the project to help us develop feature X?"
User has left the room.
3
2
32
3,022
Ah, the joys of being an Open Source maintainer. Now that our bug reporting process is precisely defined and requires a reproduction, users start creating bug reports by using the template for feature requests.
2
1
29
2,434
🎉🎉🎉
I just reached my first funding goal of $500 on GitHub Sponsors! 🤩 I'm so grateful to have so many awesome supporters! 🙏
This means the new search will be merged from Insiders to Material for MkDocs this weekend - watch out for the new release!
2
1
33
😱 Woah! We're only $11 short on the next funding goal!
github.com/sponsors/squidfun…
3...2...1... 🥳
2
1
34
Ahhh, those Sphinx vs. MkDocs discussions. Love it. 😂 Dear Sphinx users: check out MkDocstrings by @pawamoy and prepare to be amazed!
1
29
