Installation

Requirements

• Node.js >= 18.0.0
• npm, yarn, or pnpm

Package Installation

npm

npm install wiremd

yarn

yarn add wiremd

pnpm

pnpm add wiremd

Global CLI Installation

To use the wiremd command globally:

npm install -g wiremd

Verify installation:

wiremd --version

Development Installation

To contribute to wiremd or run from source:

# Clone the repository
git clone https://github.com/akonan/wiremd.git
cd wiremd

# Install dependencies
npm install

# Build the project
npm run build

# Run tests
npm test

# Link globally for development
npm link

Verify Installation

Using the CLI

# Create a test file
echo "## Test\n[Button]" > test.md

# Render it
wiremd test.md

# Should create test.html

Using the API

Create a test script test.js:

import { parse, renderToHTML } from 'wiremd';

const ast = parse('## Test\n[Button]');
const html = renderToHTML(ast);
console.log('Success! wiremd is installed.');

Run it:

node test.js

TypeScript Support

wiremd is written in TypeScript and includes type definitions. No additional @types package is needed.

import type { DocumentNode, WiremdNode } from 'wiremd';

Troubleshooting

Module not found

If you see "Cannot find module 'wiremd'":

1. Ensure you're in the correct directory
2. Run npm install again
3. Check that node_modules/wiremd exists

Permission errors (global install)

On macOS/Linux, you may need sudo:

sudo npm install -g wiremd

Or configure npm to use a different directory:

mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

Node version issues

Check your Node version:

node --version

If it's less than 18.0.0, upgrade Node.js.

Next Steps

• Getting Started Guide
• Learn the Syntax
• Explore Examples