3 ms·
While I understand the point that the article is trying to make, i.e. that no "standard" markdown offers sufficient features to write documentation, I don't thi
by h3rald 9y ago
While I understand the point that the article is trying to make, i.e. that no "standard" markdown offers sufficient features to write documentation, I don't think that it matters too much as long as the final result is good.
I always wanted to write manuals and documentation in markdown (or any other lightweight markup language for the matter) but not even a specialized flavor of markdown was able to provide all the features that a technical writer expects from a documentation tools (I am talking especially about block-level formatting and content reuse).
So I came up with HastyScribe (https://h3rald.com/hastyscribe/ https://h3rald.com/hastyscribe/) and then HastySite (https://h3rald.com/hastysite/ https://h3rald.com/hastysite/).
Basically, I used Discount as a base and added features on top of it. I am now using it for all my sites and all the documentation of my open source projects. And I know of at least one company that is using HastyScribe for their own user documentation.
OK, there's some degree of vendor lock-in, but at least the final result is OK and both tools are open source.
For more info and a preview of what an HastyScribe document looks like, here's the user guide:
https://h3rald.com/hastyscribe/HastyScribe_UserGuide.htm https://h3rald.com/hastyscribe/HastyScribe_UserGuide.htm