mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-11-18 18:32:05 +01:00
16 lines
369 B
Markdown
16 lines
369 B
Markdown
|
# User Guide for PGPainless
|
||
|
|
|
||
|
|
## Build the Guide
|
||
|
|
|
||
|
|
```shell
|
||
|
|
$ make {html|epub|latexpdf}
|
||
|
|
```
|
||
|
|
|
||
|
|
Note: Building requires `mermaid-cli` to be installed in this directory:
|
||
|
|
```shell
|
||
|
|
$ # Move here
|
||
|
|
$ cd pgpainless/docs
|
||
|
|
$ npm install @mermaid-js/mermaid-cli
|
||
|
|
```
|
||
|
|
|
||
|
|
TODO: This is ugly. Install mermaid-cli globally? Perhaps point to user-installed mermaid-cli in conf.py's mermaid_cmd
|