https://github.com/kenpusney/cnmd
CNMD
https://github.com/kenpusney/cnmd
Last synced: 6 months ago
JSON representation
CNMD
- Host: GitHub
- URL: https://github.com/kenpusney/cnmd
- Owner: kenpusney
- Created: 2016-05-10T10:13:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T00:25:21.000Z (almost 4 years ago)
- Last Synced: 2025-03-24T01:33:44.529Z (10 months ago)
- Language: TypeScript
- Homepage:
- Size: 85 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
CNMD: Cross-Notation Markdown
=======
CNMD is a syntax extension of standard markdown. It allows you setup handlers to automatically generate links.
CNMD is widely used in [kenpusney/wiki](https://github.com/kenpusney/wiki) to cross ref resources in the site, and other sites like GitHub, Wikipedia, as well as Twitter etc.
### Syntax
CNMD cross notation is pretty simple, just a colunm seperated link tag, e.g.:
```markdown
[wiki:JavaScript]()
```
means, it will call `wiki` handler and provide the link of `JavaScript`.
and the wiki handler will simply be:
```javascript
(postfix) => `https://en.wikipedia.org/wiki/${postfix}`
```
in this case, the CNMD notation will generate follow html:
```html
JavaScript
```