Browse Source

logo: added logo

pull/1/head
TiynGER 1 month ago
parent
commit
26c1bc2f63
2 changed files with 19 additions and 17 deletions
  1. +19
    -17
      README.md
  2. BIN
      amphora_wiki.png

+ 19
- 17
README.md

@ -1,5 +1,7 @@
# Amphora Wiki # Amphora Wiki
![amphora-wiki-logo](amphora_wiki.png)
This is a simple wiki based on Pythons Flask framework. This is a simple wiki based on Pythons Flask framework.
There is much great wiki software. There is much great wiki software.
Most of them are using some kind of database. Most of them are using some kind of database.
@ -8,28 +10,28 @@ I however just want to put my markdown files in a directory and get a working wi
## Features/To-Dos ## Features/To-Dos
- [x] Plain text support for wiki entries - [x] Plain text support for wiki entries
- [x] Markdown Files (.md)
- [x] Markdown Files (.md)
- [x] Entry page - [x] Entry page
- [ ] Option to get plain text file
- [ ] Optimize CSS for code
- [ ] Option to get plain text file
- [ ] Optimize CSS for code
- [x] Start page - [x] Start page
- [ ] Overview of pages and namespaces
- [ ] Overview of pages and namespaces
- [x] Search page - [x] Search page
- [x] Full-text search
- [x] Show first few lines of each match (preview)
- [ ] Better CSS
- [x] Full-text search
- [x] Show first few lines of each match (preview)
- [ ] Better CSS
- [x] Navigation - [x] Navigation
- [x] More advanced namespaces
- [x] Header
- [ ] Random article
- [ ] Search bar in header
- [x] Footer
- [x] More advanced namespaces
- [x] Header
- [ ] Random article
- [ ] Search bar in header
- [x] Footer
- [x] Switchable CSS - [x] Switchable CSS
- [x] CSS dark-theme
- [x] CSS light-theme
- [x] CSS dark-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 - [ ] Logo
## Usage ## Usage
@ -60,7 +62,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 | /wiki/src/config.py | Config file | | config-file | /wiki/src/config.py | Config file |
| entries | /wiki/src/templates/entry | Directory for wiki entries | | entries | /wiki/src/templates/entry | Directory for wiki entries |
| css | /wiki/src/static/css | (optional) Directory for css files | | css | /wiki/src/static/css | (optional) Directory for css files |
@ -71,7 +73,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
amphora_wiki.png

Before After
Width: 492  |  Height: 720  |  Size: 9.7 KiB

Loading…
Cancel
Save