jonny_bro/JaBa
1
0
Fork 0
mirror of https://github.com/JonnyBro/JaBa.git synced 2024-11-22 21:24:59 +05:00
Code Issues Projects Releases Packages Wiki Activity
JaBa/dashboard/public/bower_components/zero-md/docs
History
JonnyBro 26d5942a45 new docs page
2021-12-25 00:37:51 +05:00
..
advanced-usage new docs page 2021-12-25 00:37:51 +05:00
attributes-and-helpers new docs page 2021-12-25 00:37:51 +05:00
basic-usage new docs page 2021-12-25 00:37:51 +05:00
configuration new docs page 2021-12-25 00:37:51 +05:00
contributing new docs page 2021-12-25 00:37:51 +05:00
installation new docs page 2021-12-25 00:37:51 +05:00
migration-guide new docs page 2021-12-25 00:37:51 +05:00
recipes new docs page 2021-12-25 00:37:51 +05:00
v1 new docs page 2021-12-25 00:37:51 +05:00
app.js new docs page 2021-12-25 00:37:51 +05:00
favicon.ico new docs page 2021-12-25 00:37:51 +05:00
index.html new docs page 2021-12-25 00:37:51 +05:00
readme.md new docs page 2021-12-25 00:37:51 +05:00
sitemap.txt new docs page 2021-12-25 00:37:51 +05:00
styles.css new docs page 2021-12-25 00:37:51 +05:00

readme.md

<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.