diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 7 insertions, 5 deletions
@@ -2,7 +2,9 @@ This is a modification to the simple static site generator '[ssg](https://romanzolotarev.com/bin/ssg)' by Roman Zolotarev. This is a markdown to HTML static site generator that also creates a minimal blog index page with category headings and posts sorted by date using YAML frontmatter in markdown files. - +It also generates a sitemap.xml and rss.xml file. + + # Install / Usage @@ -23,16 +25,16 @@ publish: false --- ``` -If a file has no frontmatter, no `date`, or `publish: false`, the page won't be included in the index. It will still be rendered in sitemap.xml. +If a file has no frontmatter, no `date`, or `publish: false`, the page won't be included in the index, sitemap, or RSS feed. Setting `publish: true` is optional and equivalent to not having `publish` at all. -## Example +## Demo -There is an example directory in this repo to show you how to set up the files (src) and what the output looks like (dst). This was the command used to generate the example output: +There is a demo directory in this repo to show you an example of how to set up the files (src) and what the output looks like (dst). This was the command used to generate the demo output: ``` -./ssg-blog example/src example/dst 'https://example.org' +./ssg-blog demo/src demo/dst 'https://example.org' ``` Note a few things about the output: |