diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 60 |
1 files changed, 30 insertions, 30 deletions
@@ -1,50 +1,50 @@ -# seen +# seen flask edition *A simple blog generator* -### Facts +### Advantages over seen v0.1 -- Doesn't depend on GNU extensions +- Rewritten from scratch ; -- POSIX compliant +- Generates webpages on-the-fly: No need to run a script everytime +a new article is added ; -- Works on non-GNU distros (such as Alpine) +- Unified config file ; -- Works on BSD systems (such as MacOS and OpenBSD) +- Unified HTML5 template file ; -- Depends on `markdown`/`hoedown` +- Better RSS Feed support ; -- Less than 100 SLOC +- The code is better formatted (Less than 80 chars on every line) ; -### How to use - -First, install `markdown`/`hoedown` because this script uses it heavily. - -Put your markdown files on `articles/<name of file>.md` (create the directory if it doesn't exist). +- Licensed under the GNU AGPLv3 License. -You also need to create a config file. Put it in `articles/<name of file>.cfg`. It should use the same name your markdown file uses: +### Disadvantages over seen v0.1 - name="Hello World" - desc="Welcome to my blog!" - date="9th December 2021" +- A little bigger (seen v0.1 is 88 lines long, while seen flask edition +is 112 lines long) ; -You can create RSS feeds too, just modify the `rss.cfg` file to your liking: +- Has more dependencies. - rssEnabled="y" # Enable RSS - rssBlogTitle="foobar's blog" - rssBlogDescription="foobar loves cooking!!!!!!!" - -And run the following: +### How to use - $ chmod +x seen.sh - $ ./seen.sh +First, install `flask` and `python3-markdown`. -Your blog is in the `www/` directory. You can make your webserver use it. -You can also use CSS files, just put them into the `templates/` directory. +Put your markdown files on `articles/<name of file>.md` +(create the directory if it doesn't exist). -Feel free to customize other html files present in that directory. +You also need to add an entry in the `config.ini` file. -Seen supports other options too, for more info, run the following: +``` +[Hello_World] +Title=Hello World! +Description=Welcome to my blog! +Date=01 Oct 2022 +``` - $ ./seen.sh --help +Take a look at the `config.ini` file and modify it to your liking. +Almost every option has a comment explaining its purpose. +See +[Deploying to Production](https://flask.palletsprojects.com/en/2.2.x/deploying/) +for instructions on how to deploy Seen (or any other WSGI app). |