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

Readme now correct

Browse Source
This commit is contained in:
TiynGER 2020-06-01 20:53:51 +02:00
parent 3c49ea6687
commit a985c82bed
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -7,7 +7,7 @@ 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 blog 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 - [ ] Option to get plain text file
@ -38,12 +38,12 @@ The first line of each document is reserved as the title of the document.
### PIP/Python ### PIP/Python
- `git clone https://github.com/tiyn/tiyny-blog` - `git clone https://github.com/tiyn/tiyny-wiki`
- `cd flaskblog/src` - `cd tiyny-wiki/src`
- edit the `config.py` file according to your needs - edit the `config.py` file according to your needs
- `pip3install -r requirements.txt` - install depenencies - `pip3install -r requirements.txt` - install depenencies
- run `python app.py` - run `python app.py`
- blog is available on port 5000 - wiki is available on port 5000
### Docker ### Docker
@ -56,10 +56,10 @@ 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 | /wiki/src/config.py | Config file |
| entries | /blog/src/templates/entry | Directory for blog entries | | entries | /wiki/src/templates/entry | Directory for wiki entries |
| css | /blog/src/static/css | (optional) Directory for css files | | css | /wiki/src/static/css | (optional) Directory for css files |
| html | /blog/src/templates | (optional) Directory for templates (entry-volume not needed) | | html | /wiki/src/templates | (optional) Directory for templates (entry-volume not needed) |
#### Ports #### Ports