CrispyPin/htmd
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Crispy 2024-04-26 23:33:46 +02:00
parent 839fd164aa
commit 0df6daa906
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,12 +1,13 @@
# static site generator
All files get copied from the `write` dir to the `site` dir
all files get copied from the `write` dir to the `site` dir
Markdown files get converted to html in the process
md files get converted to html in the process
HTML is generated from `template.html`, with`{FILENAME}`(optional) and `{CONTENT}` getting replaced.
using `template.html`, which should include `TITLE` and `CONTENT`
utf-8 is required
This markdown is non compliant and I don't care. `*Emphasis*`, `**bold**` and `_underlined_` are implemented, as well as ``code``.
Standard `## Headers` up to 6 levels, and \`\`\` at the start of a line for code block (html `<pre>`) toggling. Backslashes for escaping may be added later.
There are no lists, but also automatic line breaks everywhere, so they look fine without needing html lists
ideas: