From 0df6daa9060201aeb9b7807145a1ad0c2b4739d1 Mon Sep 17 00:00:00 2001 From: CrispyPin Date: Fri, 26 Apr 2024 23:33:46 +0200 Subject: [PATCH] update readme --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5f8571e..8409c6a 100644 --- a/README.md +++ b/README.md @@ -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 `
`) 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: