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

logo: added logo

Browse Source
This commit is contained in:
TiynGER 2020-11-13 00:20:01 +01:00
parent c976549146
commit a4b2b8c314
2 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

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

BIN
beaker-blog.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB