tiyn/beaker-blog
1
0
Fork 0
mirror of https://github.com/tiyn/beaker-blog.git synced 2025-04-02 15:37:46 +02:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
TiynGER 2020-05-24 19:00:50 +02:00
parent 5455e1b650
commit c957beebc8
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -2,6 +2,22 @@
This is a simple blog based on Pythons Flask framework.
## Usage
### Create entries
Blog entries are managed by plain html files in the `templates/entry/` directory.
The first line of each document is reserved as the title of the document.
You have to specify the filetype by extension.
Currently supported filetypes are:
- HTML (.html)
- Markdown (.md)
## To-Do
- CSS upgrade
## Deployment
### PIP/Python
@ -32,19 +48,3 @@ Set the following ports with the -p tag.
#### Example run-command
`docker run --name blog --restart unless-stopped -v css:/blog/src/static/css -v html:/blog/src/templates -p 80:5000 -d tiynger/flaskblog`
## Usage
### Create entries
Blog entries are managed by plain html files in the `templates/entry/` directory.
The first line of each document is reserved as the title of the document.
You have to specify the filetype by extension.
Currently supported filetypes are:
- HTML (.html)
- Markdown (.md)
## To-Do
- CSS upgrade