SHell preprocessor for MarkDown http://dlom.cc/projects/shmd
Go to file
Dylan Lom 1fbd578186
Merge pull request #9 from dylan-lom/#5-header-wrapped-in-p-tag
(#5) Extra to remove <p> tags around <head>
2021-02-06 18:13:30 +11:00
examples (#6) Re-implement header and functions better 2021-02-06 17:38:57 +11:00
extras (#5) Add shmd-good-html script 2021-02-06 18:11:57 +11:00
.gitignore (#6) Start refactoring header logic 2021-02-06 16:43:38 +11:00
README.md Add README.md 2021-01-14 22:43:32 +11:00
build.sh Add build script, shmd and util 2021-01-14 22:48:35 +11:00
shmd.c Wrap header in <head> tags properly 2021-02-06 17:57:41 +11:00
shmd.h Wrap header in <head> tags properly 2021-02-06 17:57:41 +11:00
util.c (#2) Add str_list_free utility function 2021-01-16 20:38:13 +11:00
util.h Format util.h 2021-01-26 19:31:00 +11:00

README.md

SHell MarkDown

SHMD (Shell Markdown) is an extension to the popular Markdown markup language

The aim of this project is to allow for execution of shell-script logic in markdown files at compile time.

For compatability, and reduction of duplicated work, SHMD will be implemented as a pre-processor for markdown files, so that existing markdown converters continue to work. Converting a SHMD file to HTML may look something like this

$ shmd < myshellmarkdownfile.shmd | markdown > myhtmlfile.html

Features

  1. Execution of shell scripts can be achieved with the $(...) delimiter, in reference to a command substitution.
  2. The addition of a header section, where elements in the HTML <head> tag can be populated, and SHMD functions can be declared. The contents of the header will be converted to HTML at compilation.
  3. SHMD functions may be declared to simplify inlined scripts, for example to allow for succinct execution in other scripting languages.