pizza-wednesday
/
pizzawednes.day
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add readme

This commit is contained in:
kayomn 2023-08-18 01:31:31 +02:00
parent fabeda280a
commit db94c8e225
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
readme.md Normal file
View File

@ -0,0 +1,17 @@
# Pizza Wednesday Site
This repo contains the scripts, templates, and blog posts necessary to build the Pizza Wednesday landing site from scratch.
While only intended to be used by contributors for publishing new articles and changes to the website, the source files are publicly viewable for transparency and posterity.
## Publishing
Being a python script that is doing somewhat non-trivial stuff, `publish.py` will require some non-standard dependencies to run properly.
* `markdown` for parsing the markdown source files into HTML.
* `strip_markdown` for converting markdown source file content into plain text.
* `jinja2` for template generation of the site contents. Without tools like it, creating static websites is a fairly miserable experience
And of course a Python interpreter will be required - specifically any compatible with CPython libraries like the ones listed above.
Once these dependencies are satisifed, generating the website should be as simple as running `publish.py`. If it does fail to run at this point, please file a bug report.