Skip to main content

Generate html by markdown files and upload to qiniu to save as static site for read online

Project description

## Depends:

`python`: 2.7

`qiniu`: 6.1.6|6.x

`node`: v0.12.5

`npm`: 2.11.2

`gitbook`: 2.2.0


## Install


---

Install command:
```
pip install docbook
```

## docbook.conf

---

When you install complete,you should modify the config file: docbook.conf. for example:
```
[qiniu]
bucket_name = test-qn
ACCESS_KEY = ymtUGLMUVsngMcRRZCqnt_m9lOZ5d8pZ1T_KPhA
SECRET_KEY = toOvcxKuL7LcvQdfF646EKGX8Ak4UAR-f3scYMJ

[docbook]
prefix_path =
input_dir =
format = site
```

## docbook

---

Use to generate docment and upload to qiniu to read online. for example:

```
#docbook
```
- `input_dir` is current directory
- `output_dir` in /tmp/xxx,this directory will be auto delete when the jobs complete.
- `format` is 'site'
- `prefix_path` is null


```
#docbook -o /tmp/xxx
```
- `input_dir` is current directory
- `output_dir` is /tmp/xxx
- `format` is site
- `prefix_path` is null

```
#docbook -i input_dir -o /tmp/xxx -p aa
```
- `input_dir` is input_dir
- `output_dir` is /tmp/xxx
- `format` is site
- `prefix_path` is aa

## docbook-manage

---

Use to batch list/delete files. for example:
```
#docbook-manage -b test-qn -a list
```
- list all files in test-qn

```
#docbook-manage -b test-qn -a list -p test
```
- list all start with 'test' files in test-qn

```
#docbook-manage -b test-qn -a delete -p test
```
- delete all startwith 'test' files

```
#docbook-manage -b test-qn -a delete -p ''
```
- delete all files in bucket named: test-qn

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docbook-1.0.13.tar.gz (3.9 kB view details)

Uploaded Source

File details

Details for the file docbook-1.0.13.tar.gz.

File metadata

  • Download URL: docbook-1.0.13.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for docbook-1.0.13.tar.gz
Algorithm Hash digest
SHA256 8948ee077546a84f309b8ad032924a55e175d1856a4e8490dfdf6cfa01385448
MD5 fa1725764ced2258af9b47d2f8f99018
BLAKE2b-256 2b312a736aaa1453a2cffb1d566cd2617aad18c6041370df85f325b172128922

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page