4ae2321cfd
- Add complete installation instructions including ghcup setup - Create install-deps.sh script for system dependencies - Fix GHC version compatibility (base >=4.18 instead of 4.21) - Add puppeteer config to disable sandboxing for mermaid CLI - Update Mermaid module to use puppeteer config file 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
61 lines
1.1 KiB
Markdown
61 lines
1.1 KiB
Markdown
# Docster
|
|
|
|
A self-contained CLI tool that converts Markdown with Mermaid diagrams into PDF or HTML using Pandoc and Mermaid CLI.
|
|
|
|
## Usage
|
|
|
|
docster -pdf path/to/file.md
|
|
docster -html path/to/file.md
|
|
|
|
Mermaid code blocks (```mermaid) will be rendered to SVG and embedded.
|
|
|
|
## Installation
|
|
|
|
### Prerequisites
|
|
|
|
First install the required system dependencies:
|
|
|
|
```bash
|
|
./install-deps.sh
|
|
```
|
|
|
|
### Install Haskell toolchain
|
|
|
|
Install ghcup (Haskell toolchain installer):
|
|
|
|
```bash
|
|
curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | sh
|
|
source ~/.ghcup/env
|
|
```
|
|
|
|
Install specific GHC and Cabal versions:
|
|
|
|
```bash
|
|
ghcup install ghc 9.12.2
|
|
ghcup install cabal 3.16.0.0
|
|
ghcup set ghc 9.12.2
|
|
ghcup set cabal 3.16.0.0
|
|
```
|
|
|
|
### Install Mermaid CLI
|
|
|
|
```bash
|
|
npm install -g @mermaid-js/mermaid-cli
|
|
```
|
|
|
|
### Build and install docster
|
|
|
|
```bash
|
|
cabal install --installdir=$HOME/.local/bin
|
|
```
|
|
|
|
Make sure `~/.local/bin` is in your PATH. Add to your shell config if needed:
|
|
|
|
```bash
|
|
export PATH="$HOME/.local/bin:$PATH"
|
|
```
|
|
|
|
## Development
|
|
|
|
See [agents.md](agents.md) for information about the Claude Code agents used for Haskell refactoring in this project.
|