imsky / packdown Goto Github PK

https://github.com/tschaub/mock-fs

this will make non-file code blocks easy to add and should reduce total LOC. the grammar would still be useful to keep around, but there doesn't seem to be a need for a full parser for Packdown

• jsdoc, html output
• CLI examples for every command
• library examples for every command
• how to build, how to test
• mark lib/ (but not command) functions as private

https://github.com/archan937/templayed.js (1.3 KB, Mustache)
https://github.com/toddmotto/interpolate (0.3 KB, interpolation)
https://github.com/premasagar/tim (0.3-2.5 KB, interpolation and conditionals, needs to be forked to remove extra code)

it's not obvious how to write a structured post with attached files using the current grammar. the H2 is overloaded as the file name so it's difficult to work around. some alternatives:

• file headings can be of arbitrary level but must be wrapped in </>: # <somedir/somefile.txt>
• file headings must start with a slash: # /somedir/somefile.txt
• the file list must be separated from doc info by a rule, i.e. ---

the first approach makes files unambiguous, but doesn't comply with CommonMark's autolink spec. it could comply if the link were using a file:// schema, though that wouldn't look great and would make manual Packdown creation unfriendly.

the second approach introduces a risk where a user who wants to describe a particular file in the document info ends up adding it as a file to the Packdown document itself. this is likely a low risk to begin with, and can be mitigated by escaping the leading slash.

the third approach separates the document and files cleanly (and the grammar is already written for this use case), but it does make mixing files and document sections difficult. if a long tutorial, for example, needs to describe a file and include it immediately, the author is forced to figure out a way to link the user to the "basement" of the document - in effect this problem has to be solved by the implementer.

demo should include:

• execute js in code block
• show a pastebin using html, css, js
• download all files from a document