TFK-Blog/README.md

29 lines
846 B
Markdown
Raw Normal View History

# TFK-Blog
This is the sources for my blog.
They are generated using Pelican and based on the Flex theme.
## Prerequisites
Python dependencies :
- pelican[Markdown]
- typogrify
- beautifulsoup4 (Maybe ? Was already pulled for me)
You can install everything by running the following command :
`sudo pip3 install pelican[Markdown] typogrify beautifulsoup4`
## Build
To generate the site, you have to setup the pelican project :
`pelican-quickstart`
Then, check that the `pelicanconf.py` file has not been changed. If it has, replace it.
You can now generate the site by running `make html` and test it on your local machine, port 8000, by running `make serve`.
## Write
You can use the script `new_article.sh` to create a new article, fill its metadata and start editing it righ away. Otherwise, they are under `content/articles`