Skip to content

Getting Started

Requirements

  • Node.js 20+
  • Yamaha RTX HTML Archive — download Cmdref_HTML_Archive.zip from rtpro.yamaha.co.jp and extract it so the path Cmdref_HTML_Archive (1)/html/ exists in the project root.

Install

Option A — Pre-built binary (no Node.js required)

Download the binary for your platform from the Releases page:

PlatformFile
Linux x64rtx-manual-to-md-linux-x64
Linux ARM64rtx-manual-to-md-linux-arm64
macOS x64rtx-manual-to-md-darwin-x64
macOS ARM64 (Apple Silicon)rtx-manual-to-md-darwin-arm64
Windows x64rtx-manual-to-md-win-x64.exe
bash
# Linux / macOS — make executable then run
chmod +x rtx-manual-to-md-linux-x64
./rtx-manual-to-md-linux-x64 --stats
powershell
# Windows — cmd.exe or PowerShell (no chmod needed)
.\rtx-manual-to-md-win-x64.exe --stats

Option B — From source (Node.js 20+ required)

bash
git clone https://github.com/yuis-ice/rtx-manual-to-md
cd rtx-manual-to-md
npm install

First Run

bash
# Option A (binary)
./rtx-manual-to-md-linux-x64

# Option B (source)
npm run convert

This will:

  1. Walk ./Cmdref_HTML_Archive (1)/html/ recursively
  2. Convert every command page to Markdown
  3. Write output to ./output/ mirroring the original directory structure

Expected output:

Found 1237 command HTML files in .../html
Done: 1237 converted, 0 errors
Output: .../output

Verify the Output

bash
cat output/bgp/bgp_aggregate.md

You should see a clean Markdown file with a fenced syntax block, parameter tables, and description.

Custom Paths

bash
npm run convert -- --input /path/to/html --output /path/to/out

Next Steps

Released under the Apache 2.0 License.