specmark v0.2.3

specmark: Documentation and Testing Tool

Before testing, let's think about documentation first

specmark is a tool that allows you to compile .spec.md files to document code and test each code block later using a suite of testing tools like node:test or bun:test.

Installation

You can install specmark with brew:

$ brew install jondotsoy/core/specmark

Or with npm:

$ npm add specmark

CLI

After installing specmark, you can use the specmark command to compile .spec.md files. Here's an example of how to use it:

$ specmark
⚙️ Compiling ./hello.spec.md
 ✅ Compiled ./hello.spec.ts
 ✅ Compiled ./hello.md

Running this command in the console will compile the .spec.md files in your project, generating corresponding .md files without comments for documentation and .spec.ts files for testing purposes.