Nocturnal Pumpkin Maelstrom
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

markletjs

1.3.1 • Public • Published

Marklet

Build Status dependency npm npm bundle size (minified)

A markup language designed for API manual pages.

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> 

Install

npm i markletjs

DownloadsWeekly Downloads

2

Version

1.3.1

License

MIT

Unpacked Size

2.82 kB

Total Files

5

Last publish

Collaborators

  • avatar
  • avatar