@ziphi consider just making a simple page?
- Doesn't even have to be something fancy like #MkDocs-Material but just a simple site in #LibreOffice Writer/Web with your content on.
Or some cheap webhoster like #Netcup or @ubernauten / #Uberspace...
@ziphi consider just making a simple page?
Or some cheap webhoster like #Netcup or @ubernauten / #Uberspace...
Durch die Umstellung meines Blogs von #Wordpress auf #mkdocs kann ich das Paket bei Hetzner von Level 9 (10,90/Monat) auf Level 1 (2,09/Monat) wechseln Dort sind jetzt nur noch die Email-Postfächer der Familie und die Domains.
Dabei ist mir noch aufgefallen, dass ich beim #Nextcloud Hosting Storage Share für 1TB auf einem Alten Vertrag war (NX30). Habe den auf NX11 umgestellt, der kostet nur die Hälfte (5,11/Monat).
Web hosting advice request
Web hosting advice request
Statische Seiten mit MkDocs (Material)
Als ich vor etwa einem Jahr meinen Rechnerumzug organisierte, stolperte ich auch wieder eher zufällig über MkDocs, einen schnellen und freien (BSD-Lizenz), in Python geschriebenen, Markdown-basierten Generator für statische Seiten, der allem für die Dokumentation von Software-Projekten entwickelt worden war. https://kantel.github.io/posts/2025062101_mkdocs/ #MkDocs #Markdown #StatischeSeiten #Webworking
@jonathankoren I'm just the kind of person who expects shit to work on #LynxBrowser over @torproject and if it doesn't then it's ableist trash IMHO.
I used the nice #pdoc https://pdoc.dev/ package to **really** easily generate my #python package documentation.
I am hitting the walls of this simplicity and looking for alternatives.
I tried #sphinx a while ago and didn't really liked it.
#mkdocs seems nice.
any ideas about one of those or advantages/experiences?
What is the de facto standard for creating static #documentation websites for #OpenSource libraries? So far I've found #Docusaurus and #MkDocs, which both are popular options. I like that MkDocs' sources are #Markdown files. What else should I consider? Any suggestions?
re: substack, nazis
You'd think generating Markdown docs from Python docstrings would be straightforward and common, but apparently not.
Couldn't get lazydocs to work, reading some other things now…
On the plus side, I can just toss the `.md` files in the right spot, commit them to Codeberg, and get hosted API docs.
If I can't get this to work I can use mkdocs to pull the docstrings, generate HTML and host it on my website.
Is there someone working at #Meta that could relay this? #MkDocs is getting test PRs from trainees, apparently coming from a Meta course on Coursera. See https://github.com/mkdocs/mkdocs/pull/3965 and many other similar PRs in the tracker.
@jwildeboer
That is not just a good tip, but actually a hard requirement in many style guides for technical documentation.
For HTML output, you can avoid having to remember it via something like this:
https://squidfunk.github.io/mkdocs-material/reference/tooltips/?h=abbreviation#adding-abbreviations
@kobilacroix if you just want a cheap & simple website, that is still easy.
One option beyond "Overkill-#CMS||es" like #WordPress are "#OfflineCMS|es" like #MkDocs-Material that allow for simple #Markdown editing and clean #HTML whilst offering #search functionality.
Also there are more #Webhosters than ever before...
"Most guides to docs like code, even the ones for non-devs, assume you have some developer knowledge: maybe you're already using version control, or you've encountered build pipelines before, or you're working alongside developers.
This guide is for the people who read that paragraph and wished it came with a glossary. This is docs like code for people who don't know what git is and have never installed VS Code.
This post explains terminology and concepts, to help you get a mental model of what's going on. If you prefer to dive in and pick up concepts as you go, skip straight to the tips in How to learn, and come back to the conceptual info as needed."
#discord IS LITERALLY THE PROBLEM!
It's worse than any #IRC, #Mumble or even the old #TeamSpeak & #Skype for that matter.
It combines the disadvantages of #Forum, #paywalled #documentation, #chat and #voicechat with 0 redeeming qualities (unlike #Zulip & Mumble & #XMPP+#OMEMO) it's just an #InformationBlackhole!
I'm shure fecking #dread has better moderation and I'd rather use #MicrosoftTeams + #Slack cuz those at least have proper #moderation tools.
Case in point: I'd rather #SelfHost all my comms infrastructure than to ever use something like Discord or any other #GDPR-violating SaaS that is just enshittification.
I'd rather recommend people to instead choose a tool that does everything but horrible to go with multiple smaller & good tools
Check @alternativeto and @european_alternatives for options.
I released both TypeScript and C handler for #mkdocstrings to the public. My time is limited, my knowledge of these languages too, and these handlers are experimental, so I decided to make them public, hoping they'll get traction and contributions from people experienced in these languages
- https://mkdocstrings.github.io/typescript/
- https://mkdocstrings.github.io/c/
I'm really close to releasing the backlinks feature of mkdocs-autorefs/mkdocstrings.
I'm just working on merging this performance optimization in Python-Markdown first, because otherwise build time can increase a lot: https://github.com/Python-Markdown/markdown/pull/1510.