https://github.com/bnb/mddl
markdown documentation language
https://github.com/bnb/mddl
Last synced: 4 months ago
JSON representation
markdown documentation language
- Host: GitHub
- URL: https://github.com/bnb/mddl
- Owner: bnb
- License: mit
- Created: 2021-02-02T22:56:04.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-02T22:55:25.000Z (over 5 years ago)
- Last Synced: 2025-10-10T21:10:44.345Z (8 months ago)
- Size: 0 Bytes
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mddl
markdown documentation language
This specification is a derivation on markdown. It adds **no** new features to markdown, but adds additional rules so it is easier to author docs and build tooling around those docs.
This is directly inspired by Electron Docs [style-guide](https://github.com/electron/electron/blob/master/docs/styleguide.md) and the tooling they've built around it. The grander idea here is formalize the rules already defined by Electron, add more to them to cover more Node.js projects, and then refactor their existing tooling for use with the formalized rule set.