README.md

Marklet

A markup language designed for API manual pages.

Packages

package	version
@marklet/cli
@marklet/core
@marklet/dev-server
@marklet/parser
@marklet/renderer

Usage: CLI

Usage: marklet [options] [command]

A command line interface for marklet.

Options:
  -v, --version                       output the version number
  -h, --help                          output usage information

Commands:
  parse [options] [filepath]          Parse a marklet file into marklet AST.
  edit [options] [filepath|dirpath]   Edit a marklet file or project.
  watch [options] [filepath|dirpath]  Watch a marklet file or project.

See details here.

Usage: Node

npm i markletjs

const Marklet = require('marklet')
Marklet.watch({ source: 'path/to/file' })

Usage: Web

<script src="marklet.dist.js"></script>

<div id="#editor"></div>
<script>
  window.marklet.start({ el: '#editor' })
</script>