github.com/blag
1
0
Fork 1
mirror of https://github.com/venthur/blag.git synced 2025-11-25 20:52:43 +00:00
Code Activity

converted readme to markdown

Browse Source
This commit is contained in:
Bastian Venthur
2018-07-14 21:41:47 +02:00
parent 5dae83cc62
commit e9c5a17cc8
2 changed files with 18 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README
View File

@@ -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

18
README.md Normal file
View File

@@ -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