Re:Ask HN: What are you using for public documentation these...
by kaycebasques on Thursday November 18, 2021 @10:27AM
(#29266487)
Can you link me or explain some more what you mean by macros, fields, and transclusions? Your project makes it easy to document these aspects of a programming language? Or these are features of your documentation system itself?
Re:Ask HN: What are you using for public documentation these...
by h3rald on Thursday November 18, 2021 @04:40PM
(#29270966)
They are features of the documentation system itself, here's a simple example of macros:
https://h3rald.com/hastyscribe/HastyScribe_UserGuide.htm#Mac...
Basically it's like defining simple functions with parameters.
And here is a section about transclusion, which is a fancy tech writing word to say "include text from another file":
https://h3rald.com/hastyscribe/HastyScribe_UserGuide.htm#Tra...
- HastyScribe[1] -- an opinionated markdown compiler that supports advanced features for technical writing like macros, fields and transclusion. - HastySite[2] -- a highly customizable static site generator based on HastyScribe and min[3], another project of mine (and a pretty deep rabbit hole to go into, if you like unusual programming languages)
Examples can be found in the docs listed for most of my with my projects, here:
https://h3rald.com/projects
The only thing missing from those is search, but I could plug in LiteStore[4] and be done with it. OK, I think that's enough self-promotion for one comment, but you did ask...
[1] https://h3rald.com/hastyscribe/
[2] https://h3rald.com/hastysite/
[3] https://h3rald.com/min/
[4] https://h3rald.com/litestore/