Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erickrus/pywiki
basic implemention of Wiki
https://github.com/erickrus/pywiki
python3 wiki
Last synced: about 2 months ago
JSON representation
basic implemention of Wiki
- Host: GitHub
- URL: https://github.com/erickrus/pywiki
- Owner: Erickrus
- Created: 2022-09-19T03:54:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-01T02:22:12.000Z (over 2 years ago)
- Last Synced: 2023-07-31T12:05:25.053Z (over 1 year ago)
- Topics: python3, wiki
- Language: Python
- Homepage:
- Size: 55.7 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PyWiki
**PyWiki** is a very basic implementation of Wiki. Users could view and modify their markdown files. All markdown files can be stored under `repo` directory and Users can organize them with sub-directories.
## Installation
```shell
# clone the repository
git clone https://github.com/Erickrus/pywiki
# install required packages
sudo pip3 install -r pywiki/requirements.txt
# install mathjax
wget https://github.com/mathjax/MathJax/archive/2.7.5.zip
unzip 2.7.5.zip -d pywiki/static/js
rm 2.7.5.zip
```
## Run
```shell
python3 pywiki.py
```
You can open with your browser and access http://localhost:8080/static/index.html
## Usage
### Browse
For normal md file, you can just **browse** it with url, put the relative path name e.g. `/dir1/dir2/test.md`.
If you want to go back, just click `Back` button.
### Find
If you want to find by keywords, you can input `find: keyword1 keyword2`. Then hit enter to search.
Notice find is just search files one by one. The search engine is not leveraged yet. It could be slow when scale out.
### Edit
In `Edit` tab, you will find the corresponding markdown in text format. It can be edited and saved.