Skip to content

Commit 4863efa

Browse files
committed
docs: update readme
1 parent be20e31 commit 4863efa

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ md2report提供了CLI,如果想使用CLI,需要:
2828
- python 3.10+
2929
- poetry in PATH
3030
- pandoc in PATH
31-
31+
- [Git LFS](https://git-lfs.github.com/) installed
3232

3333
```bash
3434
git clone https://github.com/woolen-sheep/md2report.git
@@ -62,6 +62,33 @@ python md2report.py -i test/test_case/5.2数据结构实验报告.md
6262

6363
```
6464

65+
### Docker
66+
67+
```bash
68+
docker run --name md2report -d woolensheep/md2report:latest
69+
```
70+
71+
此docker为 `backend/Dockerfile` build 产物,无法作为完整的前后端使用。但是你可以进入其中运行CLI而无需搭建环境:
72+
73+
```bash
74+
➜ no-more-docx-report git:(master) ✗ docker exec -it md2report bash
75+
root@f35bd61ef8bc:/app# python md2report.py -h
76+
usage: md2report.py [-h] [-c CONFIG] [--highlight HIGHLIGHT] [-o OUTPUT] -i INPUT [-t TEMPLATE]
77+
78+
options:
79+
-h, --help show this help message and exit
80+
-c CONFIG, --config CONFIG
81+
config file path
82+
--highlight HIGHLIGHT
83+
enable highlight of code blocks
84+
-o OUTPUT, --output OUTPUT
85+
output docx filename
86+
-i INPUT, --input INPUT
87+
input markdown filename
88+
-t TEMPLATE, --template TEMPLATE
89+
template to use
90+
```
91+
6592
### Self-Hosted Web UI
6693

6794
md2docx的Web UI也是开源的,你可以使用docker-compose部署。

0 commit comments

Comments
 (0)