Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
django = "*"

[dev-packages]

[requires]
python_version = "3.11"
46 changes: 46 additions & 0 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,22 @@ A viewer and editor of markdown on local web pages.

- Based on [Python3](https://www.python.org/), [Django](http://www.djangoproject.com/) and [editor.md](https://github.com/pandao/editor.md).
- Support Standard Markdown;
- Support real-time preview, image upload.
- Support real-time preview, image uploading.
- Support [KaTeX](https://katex.org).

Please download the Python3
and run the ```start.py``` to start.
## Usage

NoteBook runs at `127.0.0.1:8014`.
``` shell
$ pip3 insall
$ # or pipenv install for Arch systems
$ python3 start.py
$ # or pipenv run python3 start.py
```

The all notebooks are storaged in ```/notebooks/```
NoteBook will run at [127.0.0.1:8014](http://127.0.0.1:8014).

and all images are storaged in ```/image/```.
The notebooks are all storaged in `/notebooks/`.

The host name cannot contain Chinese characters.
And the images are storaged in `/image/`.

The host name cannot contain Chinese characters.
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
django
10 changes: 0 additions & 10 deletions start.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,6 @@
import threading
import time


def install_package(name):
spec = importlib.util.find_spec(name)
if spec is None:
subprocess.call(['pip', 'install', name, '-i', r'https://pypi.tuna.tsinghua.edu.cn/simple'])


install_package('django')


def launch():
subprocess.call(['python', 'manage.py', 'runserver', '0.0.0.0:8014'])

Expand Down