|
|
|
@ -1,5 +1,7 @@
|
|
|
|
|
# Beaker Blog
|
|
|
|
|
|
|
|
|
|
![beaker-blog-logo](beaker_blog.png)
|
|
|
|
|
|
|
|
|
|
This is a simple blog based on Pythons Flask framework.
|
|
|
|
|
The basic design is based on LukeSmithXYZs blog.
|
|
|
|
|
However I dislike using a script for adding entries and just want to add entries via plain text files.
|
|
|
|
@ -7,26 +9,26 @@ However I dislike using a script for adding entries and just want to add entries
|
|
|
|
|
## Features/To-Dos
|
|
|
|
|
|
|
|
|
|
- [x] Plain text support for blog entries
|
|
|
|
|
- [x] HTML files (.html)
|
|
|
|
|
- [x] Markdown Files (.md)
|
|
|
|
|
- [x] HTML files (.html)
|
|
|
|
|
- [x] Markdown Files (.md)
|
|
|
|
|
- [x] Infinite-scroll blog page
|
|
|
|
|
- [x] Archive page
|
|
|
|
|
- [x] Months as headings
|
|
|
|
|
- [x] Links to scrolling blog page
|
|
|
|
|
- [x] Links to standalone article
|
|
|
|
|
- [x] Months as headings
|
|
|
|
|
- [x] Links to scrolling blog page
|
|
|
|
|
- [x] Links to standalone article
|
|
|
|
|
- [x] Standalone article page
|
|
|
|
|
- [x] Links to scrolling blog page
|
|
|
|
|
- [x] Links to scrolling blog page
|
|
|
|
|
- [x] RSS feed
|
|
|
|
|
- [x] Navigation
|
|
|
|
|
- [x] Header
|
|
|
|
|
- [x] Footer
|
|
|
|
|
- [x] Header
|
|
|
|
|
- [x] Footer
|
|
|
|
|
- [x] Switchable CSS
|
|
|
|
|
- [x] CSS dark-theme
|
|
|
|
|
- [x] CSS light-theme
|
|
|
|
|
- [x] CSS dark-theme
|
|
|
|
|
- [x] CSS light-theme
|
|
|
|
|
- [x] Config file
|
|
|
|
|
- [x] Docker installation
|
|
|
|
|
- [ ] Enable variables/environment variables
|
|
|
|
|
- [ ] Logo
|
|
|
|
|
- [ ] Enable variables/environment variables
|
|
|
|
|
- [x] Logo
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
@ -57,7 +59,7 @@ The `config.py` can be found in the `src` folder.
|
|
|
|
|
Set the following volumes with the -v tag.
|
|
|
|
|
|
|
|
|
|
| Volume-Name | Container mount | Description |
|
|
|
|
|
|-------------|---------------------------|--------------------------------------------------------------|
|
|
|
|
|
| ----------- | ------------------------- | ------------------------------------------------------------ |
|
|
|
|
|
| config-file | /blog/src/config.py | Config file |
|
|
|
|
|
| entries | /blog/src/templates/entry | Directory for blog entries |
|
|
|
|
|
| css | /blog/src/static/css | (optional) Directory for css files |
|
|
|
|
@ -68,7 +70,7 @@ Set the following volumes with the -v tag.
|
|
|
|
|
Set the following ports with the -p tag.
|
|
|
|
|
|
|
|
|
|
| Container-Port | Recommended outside port | Protocol | Description |
|
|
|
|
|
|----------------|--------------------------|----------|-------------|
|
|
|
|
|
| -------------- | ------------------------ | -------- | ----------- |
|
|
|
|
|
| 5000 | 80 | TCP | HTTP port |
|
|
|
|
|
|
|
|
|
|
#### Example run-command
|
|
|
|
|