docsub 0.3.0

Update documentation files from external content.

docsub

Update documentation files from external content.

Features

• Markdown files:
  • Fenced code blocks
• Readable shell-like rule syntax
• Idempotent

Installation

uv tool install docsub

Basic usage

This file itself uses docsub to substitute examples from test folder!

Given README.md

# Title

<!-- docsub: cat hello.txt -->
```
```

<!-- docsub: cat hello.py -->
```python
# existing text will be replaced
```

hello.txt

Hello world!

hello.py

def hello():
    print('Hi!')

Get updated README.md

$ uvx docsub -i README.md

# Title

<!-- docsub: cat hello.txt -->
```
Hello world!
```

<!-- docsub: cat hello.py -->
```python
def hello():
    print('Hi!')
```

CLI Reference

$ docsub --help
                                                            
 Usage: python -m docsub [OPTIONS] [FILE]...                
                                                            
 Update documentation files with external content.          
                                                            
╭─ Options ────────────────────────────────────────────────╮
│ --in-place  -i    Overwrite source files.                │
│ --version         Show the version and exit.             │
│ --help            Show this message and exit.            │
╰──────────────────────────────────────────────────────────╯