Web Component: j-Markdown
j-Markdown
- jComponent
v19|v20
This component contains only Markdown parser.
Configuration:
highlight
{Boolean}
enables auto-syntax highlighter (default:true
)charts
{Boolean}
enables Apex charts rendering (default:false
)
Markdown settings:
var opt = {};
var text = 'YOUR_MARKDOWN_STRING';
console.log(text.markdown(opt));
opt.wrap = true
wraps the output with<div class="markdown">YOUR_MARKDOWN</div>
opt.linetag = 'p'
a default new line tagopt.ul = true
enables unordered/ordered listsopt.code = true
enables custom codesopt.images = true
enables imagesopt.links = true
enables linksopt.formatting = true
enables basic text formattingopt.icons = true
enables Font-Awesome icons via:home:
or:cog:
opt.tables = true
enables tablesopt.br = true
enables new lines via<br>
opt.emptynewline = true
empty lines will be rendered as empty linesopt.headlines = true
enables headlinesopt.hr = true
enables page breaksopt.blockquotes = true
enables blockquotes< blockqote
opt.custom = function(line)
{ return line; }
a custom parser for each processed lineopt.html = function(line, type)
{ return line; }
a custom parser for each post-processed lineopt.sections = true
enables sections> section
opt.footnotes = true
enables footnotes#1: foot note description
and usage in links[link](#1)
opt.urlify = true
converts URL addresses to linksopt.keywords = true
parses keywords in the form{keyword}(type)
opt.noredraw = true
skips redrawing of code/video/section/block parts (default:false
)opt.element
{jQuery}
HTML element that will be used as a default element inFUNC.markdownredraw()
- NEW:
opt.bookmarks
{Boolean}
enables/disables creating headline bookmarksid=""
(default:true
) - NEW:
opt.prefix
{String}
a prefix for bookmarks (default:empty
)
Good to know:
- images will be with
img-responsive
class - images with
![+Image description](URL)
will be formatted as an inline image - images with
![-Image description](URL)
will be rendered as an inline image with classgallery
instead ofimg-responsive
- all links are with
_target="_blank"
attribute - markdown registers
FUNC.markdownredraw(jQuery_selector, [markdown_options])
for prerendering of Markdown dynamic elements like code highlight, videos or charts - secret section is defined like code with syntax
secret
- class
markdown-small
can decrease font sizes - event
ON('markdown', function(el, opt) {})
is executed if the markdown is pre-rendered (el
{jQuery}
is<body
element in most cases) - components registers
Thelpers.markdown([opt])
helper - NEW: every rendered line contain
markdown-line
class anddata-line="line_number"
attribute
Toggleable section:
::: Section name
Another markdown content
:::
Author
- Peter Širka petersirka@gmail.com
License
Created
22. may 2019
Updated
14. september 2024
jComponent library
19 | 20
Version
v1
License
https://www.totaljs.com/license/
Dark mode
Yes
Responsive
Yes
Author
Peter Širka
Email
petersirka@gmail.com