A boilerplate .html
file that renders your README.md
https://vsharapov.github.io/INDEXmd/?text-width=readable
Just save this .html
file to your repo's directory
Stuff you might wanna mess with:
fileToRender = 'README.md';
display:none
in the style
of the indexmdmenu
will hide itmenuOptions
defaults can be changed
readable
is hardcoded to ...maxWidth = "70ch";
makeFaviconText(document.title);
truncated (~2 letters)
document.title
hardcode something 🅱
etter like 竜
or 🆒
font-family="mono"
etc… in the svgnew showdown.Converter();
e.g. showdown.setOption('tables', true);
console.log(showdown.getOptions());
color: maroon;
This a test of all markdown possibilities:
This is bold text
This is bold text
This is italic text
This is italic text
Strikethrough (non-spec)
This is an example inline link.
This link has no title attribute.
Blockquotes can also be nested...
...by using additional greater-than signs right next to each other...
...or with spaces between arrows.
+
, -
, or *
1.
Like links, Images also have a footnote style syntax
With a reference later in the document defining the URL location:
(non-spec)
Option | Description |
---|---|
data | path to data files to supply the data that will be passed into templates. |
engine | engine to be used for processing templates. Handlebars is the default. |
ext | extension to be used for dest files. |
Right aligned columns
Option | Description |
---|---|
data | path to data files to supply the data that will be passed into templates. |
engine | engine to be used for processing templates. Handlebars is the default. |
ext | extension to be used for dest files. |
Inline code
Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
Block code "fences"
Sample text here...
Syntax highlighting (non-spec)
var foo = function (bar) {
return bar++;
};
console.log(foo(5));