Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# HTTP-API
## Documentation
The documentation of this project is located in confluence:
https://beebryte.atlassian.net/wiki/spaces/AQTMN/overview?homepageId=452002085
## Installation
```bash
pip install -r requirements.txt
```
Define the following environment variables:
```bash
CONFLUENCE_API_KEY=<your api key>;
CONFLUENCE_DOMAIN=beebryte.atlassian.net;
CONFLUENCE_PATH=/wiki/;
CONFLUENCE_SPACE_KEY=AQTMN; # The space key of the space to which pages belongs
CONFLUENCE_USER_NAME=<your username>;
```
## Usage
```bash
python -m md2conf .
```
## Pre-commit hooks
Please use the pre-commit hooks provided in this repository to maintain consistency in
the codebase.
### Setup
```bash
pip install --upgrade pip
pip install pre-commit
pre-commit install
pre-commit autoupdate
```
### Manual use
```bash
pre-commit run --all-files
```