update readme
This commit is contained in:
parent
839fd164aa
commit
0df6daa906
1 changed files with 6 additions and 5 deletions
11
README.md
11
README.md
|
@ -1,12 +1,13 @@
|
||||||
# static site generator
|
# 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`
|
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.
|
||||||
utf-8 is required
|
There are no lists, but also automatic line breaks everywhere, so they look fine without needing html lists
|
||||||
|
|
||||||
|
|
||||||
ideas:
|
ideas:
|
||||||
|
|
Loading…
Reference in a new issue