From e9c5a17cc8196fc0997182b65c1f514ac286e907 Mon Sep 17 00:00:00 2001 From: Bastian Venthur Date: Sat, 14 Jul 2018 21:41:47 +0200 Subject: [PATCH] converted readme to markdown --- README | 19 ------------------- README.md | 18 ++++++++++++++++++ 2 files changed, 18 insertions(+), 19 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 2f7faa2..0000000 --- a/README +++ /dev/null @@ -1,19 +0,0 @@ -How to use -========== - -Populate directory with markdown files (they have to end with .markdown). You -can also create arbitrarily nested subdirectories containing .markdown files. - -Sg will go recursively through all directories not beginning with an underscore -("_") and convert the .markdown files into .html. The resulting HTML files will -be saved into the _site directory, conserving the directory structure where the -.markdown file was found. - -Put your static content into _static. Files and subdirectories will be copied -into _site without any modifications. - -TODO -==== - - * document the YAML frontmatter - * enable layout selection by _layout_foo or so diff --git a/README.md b/README.md new file mode 100644 index 0000000..2fecce9 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# sg.py -- a small static site generator + +Populate directory with markdown files (they have to end with +.markdown). You can also create arbitrarily nested subdirectories +containing .markdown files. + +Sg will go recursively through all directories not beginning with an +underscore ("_") and convert the .markdown files into .html. The +resulting HTML files will be saved into the _site directory, conserving +the directory structure where the .markdown file was found. + +Put your static content into _static. Files and subdirectories will be +copied into _site without any modifications. + +## TODO + +* document the YAML frontmatter +* enable layout selection by _layout_foo or so