summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid Luevano Alvarado <david@luevano.xyz>2022-04-23 20:47:19 -0600
committerDavid Luevano Alvarado <david@luevano.xyz>2022-04-23 20:47:19 -0600
commitdfc3e6db921815416b8edc5892b2a7adfc677a25 (patch)
tree545c66fa2102c10d3b85c5318e76e446aee30ef6 /README.md
parent7ecd3c9501a16da6c1872ed7521f93df9a8da7f5 (diff)
add checksum checking for mod files instead of timestampv0.7.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8a56246..3aee523 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@ Inspired (initially) by Roman Zolotarev's [`ssg5`](https://rgz.ee/bin/ssg5) and
## Features and to-do
+**Please note that since this is a WIP, there will be changes that will break your site setup (the database management, for example). Read the tag notes for any possible break between the version you're using and the one you're updating to.**
+
- [x] Build static site parsing `markdown` files ( `*.md` -> `*.html`)
- [x] ~~Using plain `*.html` files for templates.~~ Changed to Jinja templates.
- [x] Would like to change to something more flexible and easier to manage ([`jinja`](https://jinja.palletsprojects.com/en/3.0.x/), for example).
@@ -23,7 +25,8 @@ Inspired (initially) by Roman Zolotarev's [`ssg5`](https://rgz.ee/bin/ssg5) and
- [x] Avoid the program to freak out when there are directories created in advance.
- [x] Provide more meaningful error messages when you are missing mandatory metadata in your `*.md` files.
- [ ] More complex directory structure to support multiple subdomains and different types of pages.
-- [ ] Add option/change to using an SQL database instead of the custom solution.
+- [ ] Option/change to using an SQL database instead of the custom solution.
+- [x] Checksum checking because the timestamp of the file is not enough.
### Markdown features
@@ -131,6 +134,7 @@ rss_date=%%a, %%d %%b %%Y %%H:%%M:%%S GMT # fixed
sitemap_date=%%Y-%%m-%%d # fixed
[info]
version= # current 'pyssg' version (0.5.1.dev16, for example)
+debug=True/False # depending if --debug was used when executing
rss_run_date= # date the program was run, formatted with 'rss_date'
sitemap_run_date= # date the program was run, formatted with 'sitemap_date'
```