docsub 0.1.0

Update documentation files with external content.

docsub

Update documentation files with external content.

Features

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

Installation

uv tool install docsub

Basic usage

Give README.md

# Title

```<- cat hello.txt
```

```python <- cat hello.py
existing text is replaced
```

hello.txt

Hello world!

hello.py

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

Get updated README.md

$ uvx docsub -i README.md

# Title

```<- cat hello.txt
Hello world!
```

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

CLI Reference

Yes, I eat my own dog food.

                                                            
 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.            │
╰──────────────────────────────────────────────────────────╯