joggrdocs/marathon

Standard documentation templates, with a programmatic interface.

---

"It's a marathon, not a sprint." - Coach Campbell

Overview

Library of markdown templates for engineering documentation with a programmatic interface.

Getting Started

npm

npm install @joggr/marathon

yarn

yarn add @joggr/marathon

Example

import fs from 'node:fs/promises';
import marathon from '@joggr/marathon';

const result = marathon.run('api-basic', {
    title: 'This is a title'
});

fs.writeFile('API.md', result);