mirror of
https://github.com/JonnyBro/JaBa.git
synced 2024-11-27 07:34:59 +05:00
.. | ||
advanced-usage | ||
attributes-and-helpers | ||
basic-usage | ||
configuration | ||
contributing | ||
installation | ||
migration-guide | ||
recipes | ||
v1 | ||
app.js | ||
favicon.ico | ||
index.html | ||
readme.md | ||
sitemap.txt | ||
styles.css |
<zero-md>
Ridiculously simple zero-config markdown displayer
A native markdown-to-html web component based on Custom Elements V1 specs to load and display an external MD file. Under the hood, it uses Marked for super-fast markdown transformation, and Prism for feature-packed syntax highlighting - automagically rendering into its own self-contained shadow DOM container, while encapsulating implementation details into one embarassingly easy-to-use package.
NOTE: This is documentation for V2. If you're looking for the older version, see the V1 docs.
Featuring:
- Automated hash-link scrolls
- Built-in FOUC prevention
- Automatically rewrite URLs relative to
src
- Automatically re-render when
src
changes - Automatically re-render when inline markdown or style template changes
- Support for >200 code languages with detection for unhinted code blocks
- Easy styling mechanism
- Highly extensible
NOTE: Your markdown file(s) needs to be hosted! Browsers don't generally allow javascript to access files on the local hard drive because of security concerns. Standard CORS rules apply.