https://github.com/ethan-arrowood/mddl

markdown documentation language
https://github.com/ethan-arrowood/mddl

Last synced: 12 days ago
JSON representation

markdown documentation language

• Host: GitHub
• URL: https://github.com/ethan-arrowood/mddl
• Owner: Ethan-Arrowood
• License: mit
• Created: 2021-02-02T22:41:27.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T06:28:55.000Z (2 months ago)
• Last Synced: 2024-11-16T01:52:13.127Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 197 KB
• Stars: 30
• Watchers: 3
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# mddl

markdown documentation language

**mddl** is a subset of markdown. It adds **no** new features to markdown, but adds additional rules so it is easier to author JavaScript documentation.

**mddl** looks like this:

```md

# Object: FetchOptions

An object containing any custom settings you want to apply to the request.

Parameters:

*   **method** - `string` - _optional_ - Default: `'GET'` - The request method, e.g., `"GET"`, `"POST"`

*   **headers** - `Headers | Record` - _optional_ - Any headers you want to add to your request.

```

> **mddl** is very early in development. It is currently _not_ published to any registry. Enable notifications for this repo and follow [@ArrowoodTech](https://twitter.com/ArrowoodTech) on Twitter for latest updates.

## Packages

*   [`@mddl/spec`](./packages/spec/) - complete specification for **mddl**

*   [`@mddl/ast`](./packages/ast/) - AST forms and types

*   [`@mddl/from-mdast`](./packages/from-mdast/) - [mdast](https://github.com/syntax-tree/mdast) to [`@mddl/ast`](./packages/ast/) transformer package.

## Try it out!

Inside of [`@mddl/from-mdast`](./packages/from-mdast/) is an `example.js` you can run locally. Give it a try!

---

This project was originally inspired by Electron Docs [style-guide](https://github.com/electron/electron/blob/master/docs/styleguide.md).