https://github.com/obstudio/marklet

A markup language designed for API manual pages.
https://github.com/obstudio/marklet

marklet markup

Last synced: 10 months ago
JSON representation

A markup language designed for API manual pages.

• Host: GitHub
• URL: https://github.com/obstudio/marklet
• Owner: obstudio
• License: mit
• Created: 2018-07-13T02:40:07.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-10-31T13:30:22.000Z (over 7 years ago)
• Last Synced: 2025-07-03T13:53:39.502Z (12 months ago)
• Topics: marklet, markup
• Language: TypeScript
• Homepage:
• Size: 493 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Marklet

[![Build Status](https://travis-ci.com/obstudio/Marklet.svg?branch=dev)](https://travis-ci.com/obstudio/Marklet)

[![dependency](https://img.shields.io/david/obstudio/Marklet.svg)](https://github.com/obstudio/Marklet/blob/master/package.json)

[![npm](https://img.shields.io/npm/v/markletjs.svg)](https://www.npmjs.com/package/markletjs)

[![npm bundle size (minified)](https://img.shields.io/bundlephobia/min/markletjs.svg)](https://www.npmjs.com/package/markletjs)

A markup language designed for API manual pages.

## Packages

| package | version |

|:-------:|:-------:|

|[@marklet/cli](https://github.com/obstudio/Marklet/tree/master/packages/cli)|[![npm](https://img.shields.io/npm/v/@marklet/cli.svg)](https://www.npmjs.com/package/@marklet/cli)|

|[@marklet/core](https://github.com/obstudio/Marklet/tree/master/packages/core)|[![npm](https://img.shields.io/npm/v/@marklet/core.svg)](https://www.npmjs.com/package/@marklet/core)|

|[@marklet/dev-server](https://github.com/obstudio/Marklet/tree/master/packages/dev-server)|[![npm](https://img.shields.io/npm/v/@marklet/dev-server.svg)](https://www.npmjs.com/package/@marklet/dev-server)|

|[@marklet/parser](https://github.com/obstudio/Marklet/tree/master/packages/parser)|[![npm](https://img.shields.io/npm/v/@marklet/parser.svg)](https://www.npmjs.com/package/@marklet/parser)|

|[@marklet/renderer](https://github.com/obstudio/Marklet/tree/master/packages/renderer)|[![npm](https://img.shields.io/npm/v/@marklet/renderer.svg)](https://www.npmjs.com/package/@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](https://github.com/obstudio/Marklet/blob/master/packages/cli/README.md).

## Usage: Node

```shell

npm i markletjs

```

```js

const Marklet = require('marklet')

Marklet.watch({ source: 'path/to/file' })

```

## Usage: Web

```html

```

```html



  window.marklet.start({ el: '#editor' })

```