djl
/
shmd
1
0
Fork 0
Code Issues 5 Pull Requests Projects Releases Wiki Activity

Add README.md

This commit is contained in:
Dylan Lom 2021-01-07 19:17:24 +11:00
commit 01b49c8e58
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# **SH**ell **M**ark**D**own
SHMD (Shell Markdown) is an *extension* to the popular [Markdown][1] 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].
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.
[1]: https://daringfireball.net/projects/markdown/
[2]: https://www.gnu.org/software/bash/manual/html_node/Command-Substitution.html