#TechnicalWriting#SoftwareDocumentation#Markdown#XML#DITA: "Think about how in Markdown you would ensure that “all our how-to guides must have an h1 title, followed by one or more paragraphs, followed by one or more steps to achieve the guide’s goal”, and then consider how easy it is in DITA.
This is just not really possible today, at least in any popular Markdown-based framework.
There is a path
Bridging the gap between Markdown and structured authoring will require building new tooling and standards. It’s unlikely that CommonMark or any other popular Markdown flavor would consider going in this direction, so we’ll have to create tools around Markdown.
We at Doctave have some ideas about how to achieve this, and have a roadmap on how to get there. At a high level there are a few things we would need:
✅ A parser and template system that is Markdown-aware
❌ A language for describing constraints and rules for your Markdown content
❌ An engine that enforces those rules on your content
We’re already part of the way there!"
What are people using to test their website's accessibility (a11y)?
Since I use Hugo to generate the pages, my source is all Markdown, so I was hoping to find something I can just point at my website, like a linter. Unless there's a Markdown a11y linter I don't know about…
Hm. Is there a #CLI#Markdown renderer that can do "display foo.md beautifully in the terminal, and highlight whatever source line 123 contained (which is almost certainly not output line 123)"?
I have a collection of Markdown documents and would like to run full-text search on them, e.g. using #ripgrep, but I don't want the results to be displayed as raw Markdown, but instead be rendered in the terminal, but still see where the result is. Any ideas?
🎉 You can now use components and fragments in your Markdown pages in Kitten.
Following on from yesterday’s Markdown pages feature, you can now import components and fragments and use them in your Markdown pages to add dynamic functionality (similar to how it works in mdx but without using JSX).
(The “SCARY” text in the screencast is being randomly animated by a component.)
You can now create .page.md files and use front matter to specify a layout template as well as any other props you want to pass to your layout.
(I’m working on the Kitten web site with docs, etc., so I thought I’d bite the bullet and add this feature this morning to make my life easier. Should make it easier to make this sort of site with Kitten in the future for everyone.)
I'm investigating options that are available to create a table of contents in #markdown, really wondering what people are using to create that when writing markdown based docs.
If you write and publish a book 📖 on Leanpub you don’t just get great PDF, EPUB, and Print-Ready PDF files: we also help you actually sell it, and we take care of customer support! And it’s all free in our write-in-your-browser writing mode! #markua#markdown#writing#books
Does anyone else maintain #changelog (s) for their #computer (s)?
I enter all configuration adjustments and #update (s) in a #markdown file for each machine.
This might seem like unnecessary extra work, but has paid off several times for the sake of traceability or #reproducibility in the past. 🤓 #musicproduction#linuxaudio
This week: Using paper for finance tracking has been invaluable for helping me understand the process, shaping my Markdown budget trackers into a text-based, hands-on envelope budgeting approach. Simple calculations mean I can take charge of my incomings and outgoings without a standard spreadsheet.
#Gitlab still doesn't support issue templates in #yaml, the way #Github and #Forgejo can. Only #Markdown, which is a lot less attractive. But #Github and #Gitlab can do label changes in the Kanban (project) view, which #Forgejo can't.
DEVONthink To Go 3.8.2 is here. It supports the PDF bookmarklet and no longer applies default styling to Markdown when you use your own CSS. The new version also shows fewer notifications, checks for broken file permissions, and improves VoiceOver support. #devonthinktogo#devonthink#pkm#markdown#css#voiceoverhttps://buff.ly/3yl1yyB
For my #Markdown nerds. I don't know when this was launched, but it showed up in my Snaps this morning.
'dumpspage is a Markdown note-taking web-app that is powered by markdown-it and CodeMirror. Simply create your note using that big ol’ button and you are ready to take some notes (no login required!).'
Perfect, the combination of playwright, trafilatura and scrapinghub extracts all the information I need from a webpage. My little #python project evolves nicely.
The screenshot shows the power of trafilatura. With a single statement it creates wonderful #markdown from any webpage it can extract content from. Extracting links, keeping the basic markup and structure, and dereference relative links.
Just got an e-mail from #storyblok informing me that one of their sub-processors (whatever that means) is now #OpenAI.
I immediately asked them if the content I created will be used in any way to train their #LLM and if so, I want no part in it. Requested a back-up of my data and to delete everything.
I used it for the first iteration of my blog but switched to #markdown a while ago.
Was möchte man denn für Notizen verwenden, wenn man diese auf #Linux, #Android oder #Windows erstellen und bearbeiten möchte. Verteilt auf verschiedene Geräte sollen diese über #Syncthing werden.
One of the features I love in XCode is the sticky lines showing the class/method you've scrolled down in.
I love it so much I'm desperate to also have it in Android Studio, turns out it's coming in the next version! (Koala 2024.1.1)
Guess who's now using the canary release 😄