diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..5663ebc --- /dev/null +++ b/README.rst @@ -0,0 +1,28 @@ +the Stupid Blogging System, static version +========================================== + +This is the repository for the Stupid Blogging System (sbs) version 2.5+. + +List of features of the SBS: + - Post in HTML, or anything that can be converted into HTML + - Tags + - Passphrase-based content encryption (JavaScript required) + - Automatic table of contents and footnotes generation + - Generates static webpages, ready to be served with httpd + - Flexible templates + - Automatic image compression (TODO, using imagemagick) + +Dependencies: + - node.js >8.x + - jsdom + - aes-js + - scrypt-js + +Usage: + +In directory ``generator``:: + + node main.js [--force] + +--force: + ignores time stamp and force generation of all pages. |