#materialformkdocs

2024-12-02

🚀 I've just released the version 1.17.0 of the RSS plugin for MkDocs: github.com/Guts/mkdocs-rss-plu

đź“° It improves the integration with the blog plugin of the awesome Material for Mkdocs framework, developed by @squidfunk and co.

đź“‘ More details in documentation: guts.github.io/mkdocs-rss-plug

#MkdocsRssPlugin #MaterialForMkdocs #RSS #json_feed #MkDocs

2024-10-24

🚀 New version 1.16.0 of Mkdocs RSS plugin

It ships an extended integration with Material Social Cards plugin by supporting cards generated for Material Blog posts (which have specific paths).

Release notes: guts.github.io/mkdocs-rss-plug

#Mkdocs #MaterialForMkdocs #RSS

2024-10-24

@squidfunk
After my previous experimentation I converted my website to #MaterialForMkDocs , restructured the content and added pages on #photography nicorikken.eu/

2024-08-15

I checked how usable the #MaterialForMkDocs theme is in text-based webbrowers #lynx and #w3m. I'm impressed with a 'skip to content' to jump over the table of contents, good rendering of tables and footnotes working nicely. Unfortunately search doesn't work, as it depends on JavaScript and uses a popover. I already use the theme for documentation at work and am considering it for my personal website now. I can highly recommend it squidfunk.github.io/mkdocs-mat @squidfunk

2024-06-24

After several months with no time to devote to the project, I was able to get back to work on the #RSS plugin for #mkdocs (guts.github.io/mkdocs-rss-plug).

Some of highlights:

- support for JSON feed (RSS translation into JSON)
- support for multiple instances (typically, a feed for your doc a feed for your blog within the same site base)
- customizable output filenames
- improved integration with social cards of #MaterialForMkdocs framework (cc @squidfunk )
- modernized config to fit Mkdocs 1.6+

Timothée Mazzucotelli :python:pawamoy@fosstodon.org
2024-06-12

I'm completely rewriting #Griffe's docs. Griffe is all about public APIs, so its API docs should be exemplary.

These will be the best docs I've written until now. I've taken inspiration from projects with great documentation: #Hatch, #MaterialforMkDocs and #Textual notably 🙂

Screenshot of a docs page built with MkDocs and Material for MkDocs.
Asterisk 🇨🇦asterisk@social.linux.pizza
2024-05-16

After building the #blendos preview #docs with #materialformkdocs, we now have to build a new v4 ISO because of a pkgbuild mirror change from tar.gz to tar.zst. Rudra said he was gonna build a new ISO and has not responded since. v4 currently cannot be installed.

This is wonderful. Rudra is usually absent for a while due to school and Ubuntu Unity, but this is one of the downsides of that.

:blobono:

(the docs are at blend-docs-material.pages.dev for now if you even care)

#linux #sad #foss

2023-12-17

🚀 Recently, I've released new versions of the RSS plugin for Mkdocs with some exciting improvements and features:

- integration with Social Cards of Material theme of @squidfunk
- compatibility with Mkdocs>=1.4: configuration object, plugin logger, etc.
- renewed documentation
- Python 3.12 support

đź‘€ Check it up: guts.github.io/mkdocs-rss-plug

#RSS #Mkdocs #MaterialForMkdocs

Screenshot of RSS feed (through Want My RSS Firefox extension) with social card integrated as feed's item enclosure.
2023-10-18

📚 Il y a un effort conséquent sur la documentation écrite en Markdown et publiée sur GitHub Pages : geoplateforme.github.io.

Oui, c'est la mĂŞme techno que @geotribu :geotribu: (#Mkdocs
et #MaterialForMkdocs de @squidfunk ). Les grands esprits ne seront pas perdus.

Capture d'écran d'une page de la documentation de l'API Entrepôt de la Géoplateforme.

Le site est basé sur Mkdocs et le thème Material, à l'instar du site Geotribu
Andre_601 :neofox_cofe: ​andre_601@blobfox.coffee
2023-09-21

@minecraft 1.20.2 came out with some neat Resource pack changes and other features, #MaterialForMkDocs releases 9.4.0 with darker dark theme and @Mastodon releases 4.2 with also nice features...

Today is a good day guys.

Andre_601 :neofox_cofe: ​andre_601@blobfox.coffee
2023-09-05

I updated the CSS and HTML template of my Mastodon-based comment-system to now resemble a actual Mastodon comment more closely.

The CSS also includes colours for Material for MkDocs' white (default) theme!

@MkDocs #materialformkdocs #mkdocs

Andre_601 :neofox_cofe: ​andre_601@blobfox.coffee
2023-08-29

I've spend the past 4 hours or so making a API reference for the API of my plugin #AdvancedServerList

I'm happy with how it turned out.
Keep in mind that I did this by hand, meaning I didn't use any sort of generator or alike...

docs.andre601.ch/AdvancedServe

#mkdocs #materialformkdocs

Andre_601 :neofox_cofe: ​andre_601@blobfox.coffee
2023-07-19

@dpecos Made a variant that works for #mkdocs and #materialformkdocs
The Paste has basic instructions on how it can be implemented.
paste.gg/p/Andre601/4d1323b59c

Andre_601 :neofox_cofe: ​andre_601@blobfox.coffee
2023-07-17

@dpecos Found your blog post and I'm now curious...
Do you by any chance know what adjustments would be needed to make it work with #mkdocs and the #materialformkdocs theme?

Like, I'm not entirely sure what CSS changes/additions I would need to make to include proper looking mastodon comments for my blog posts.

So far I copied the code snippet and adjusted the variables inside it to make it work with the #jinja2 syntax and so far it seems to work.

Now I just need to properly format everything, so if you could help by any means I would apreciate it (Even if it was just linking the (S)CSS used).

@aviram @feorlen #MaterialForMkDocs is the software, not a hosting platform. It looks closest to what I am aiming for, but it uses a development model where features are released under permissive licenses once the dev hits funding thresholds, but are available to sponsors early. At the moment that includes most of the blogging functionality.

2022-11-19

Yesterday night I dedicated some time to improve the documentation of my web framework, and tried enabling #giscus comments. It works wonderfully and it's so user friendly to enable! ❤️

(this is still on my localhost)

#materialformkdocs #mkdocs #documenting

A picture of the commenting system provided by Giscus, in a MkDocs site.

Client Info

Server: https://mastodon.social
Version: 2025.04
Repository: https://github.com/cyevgeniy/lmst