Coming from #MkDocs on #ReadTheDocs , I think about migrating our projects user manual to #Asciidoc using #asciidoctor and/or #antora .
But I wonder if there is a service like #readthedocs for #asciidoc based manuals available for #OpenSource or #foss projects.
Important is that those platforms do support @Codeberg (#forgejo aka #gita ) code hosting, instead of Microsoft GitHub.
Build a blog in Three Minutes with Three Commands
http://readbeanicecream.surge.sh/2025/05/02/build-your-blog-in-three-commands/
#technology #tech #technicalwriting #opensource #foss #linux #mkdocs #mkdocs_material #surge #web #websites #net #internet
@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
kommt drauf an. BookStack ist schon ganz schön umgesetzt, aber so sehr buchorientiert. Für Dokumentationen oder Notizen finde ich ein Wiki eigentlich besser. Für Teams würde ich die Kombination #git mit #mkdocs, #asciidoctor oder #sphinx verwenden.
https://git-scm.com
https://www.mkdocs.org
https://asciidoctor.org
https://www.sphinx-doc.org
Jag provade en #MkDocs plugin som skapar "social cards", bilder som skall bli snygga förhandsvisningar när en sida delas. Det blir ju bättre än inget. Jag har inte anpassat dem något än.
Men så blir det problem med att skapa siten där den driftas nu och genast känns det enklare att skapa den lokalt och ftp:a till nåt webhotell. Känns som förra milleniet. 😄
Men med Make går det att göra allt med ett kommando. #oldschool
#Python Friday #276: Fix Social Links in #RSS Feed of #MkDocs
https://pythonfriday.dev/2025/04/276-fix-social-links-in-rss-feed-of-mkdocs/
@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."
https://deborahwrites.com/blog/docs-like-code-basic-intro/
#TechnicalWriting #SoftwareDocumentation #SoftwareDevelopment #Programming #DocsAsCode #Git #Markdown #TechnicalCommunication #MkDocs #VSCode
Интеграция виджета обратного звонка МТС Exolve в документацию на MkDocs
Привет, Хабр! Это Екатерина Саяпина, Product Owner платформы
https://habr.com/ru/companies/ru_mts/articles/900676/
#мтс_exolve #exolve #mkdocs #docker #статический_сайт #модальное_окно #user_experience #api #вебразработа #виджет_обратного_звонка
#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.
Shoutout to @squidfunk for making Material for MkDocs which comes with a metric ton of #QualityOfLife improvements like being easily able to self-host all assets and thus comply with #privacy #laws whilst being as easy to setup as the regular #MkDocs.
So... First experiments with using Obsidian and mkdocs to create a static website has been successful.
As have been tests, setting up the free version of CloudFlare to protect my stuff from 'AI crawler bots'.
Next on the list, converting a Wordpress blog into an Obsidian vault and turn it into a static website.
With the current situation at Wordpress going on, I'm not exactly trusting them...
@memesmadetorunonlinux you know what's real #GigaChad in terms of #Presentations?
For everyone else there's #MkDocs (or rather #MkDocsMaterial) for making beautiful #HTML presentations...
