A blog system based on plain-files.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

67 lines
2.1 KiB

7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
  1. # Python Flask Blog
  2. This is a simple blog based on Pythons Flask framework.
  3. The basic design is based on LukeSmithXYZs blog.
  4. However I dislike using a script for adding entries and just want to add entries via plain text files.
  5. ## Features/To-Dos
  6. - [x] Plain text support for blog entries
  7. - [x] HTML files (.html)
  8. - [x] Markdown Files (.md)
  9. - [x] Infinite-scroll blog page
  10. - [x] Archive page
  11. - [x] Months as headings
  12. - [x] Links to scrolling blog page
  13. - [x] Links to standalone article
  14. - [x] Standalone article page
  15. - [x] Links to scrolling blog page
  16. - [x] RSS feed
  17. - [ ] Better navigation
  18. - [ ] Header
  19. - [ ] Footer
  20. - [ ] Switchable CSS
  21. - [ ] CSS dark-theme
  22. - [ ] CSS light-theme
  23. - [x] Docker installation
  24. ## Usage
  25. ### Create entries
  26. Blog entries are managed by plain html files in the `templates/entry/` directory.
  27. The first line of each document is reserved as the title of the document.
  28. You have to specify the filetype by extension.
  29. ## Deployment
  30. ### PIP/Python
  31. - `git clone https://github.com/tiyn/tiyny-blog`
  32. - `cd flaskblog/src`
  33. - `pip3install -r requirements.txt` - install depenencies
  34. - run `python app.py`
  35. - blog is available on port 5000
  36. ### Docker
  37. #### Volumes
  38. Set the following volumes with the -v tag.
  39. | Volume-Name | Container mount | Description |
  40. |-------------|----------------------|-----------------------------------------------------------------------|
  41. | css | /blog/src/static/css | Directory for css files |
  42. | html | /blog/src/templates | Directory for templates and html documents (contains entry directory) |
  43. #### Ports
  44. Set the following ports with the -p tag.
  45. | Container-Port | Recommended outside port | Protocol | Description |
  46. |----------------|--------------------------|----------|-------------|
  47. | 5000 | 80 | TCP | HTTP port |
  48. #### Example run-command
  49. `docker run --name blog --restart unless-stopped -v css:/blog/src/static/css -v html:/blog/src/templates -p 80:5000 -d tiynger/tiyny-blog`