INDEX.md

A boilerplate .html file that renders your README.md

Demo

https://vsharapov.github.io/INDEXmd/?text-width=readable

How to add this to your repo:

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 it
• menuOptions defaults can be changed
  • readable is hardcoded to ...maxWidth = "70ch";
• The icon is just the makeFaviconText(document.title); truncated (~2 letters)
  • Instead of document.title hardcode something 🅱etter like 竜 or 🆒
  • Fit more characters by changing font-family="mono" etc… in the svg
• Markdown parser options
  • Before new showdown.Converter(); e.g. showdown.setOption('tables', true);
  • See defaults (and all options) with console.log(showdown.getOptions());
• Da🅽k mode: color: maroon;

---

---

This a test of all markdown possibilities:

---

Headings

h1 Heading 1

h2 Heading 2

h3 Heading 3

h4 Heading 4

h5 Heading 5

h6 Heading 6

---

Horizontal Rules

---

---

---

---

Emphasis

This is bold text

This is bold text

This is italic text

This is italic text

Strikethrough (non-spec)

---

Links

link text

link with title

This is an example inline link.

This link has no title attribute.

---

Blockquotes

Blockquotes can also be nested...

...by using additional greater-than signs right next to each other...

...or with spaces between arrows.

---

Lists

Unordered

• Create a list by starting a line with +, -, or *
• Sub-lists are made by indenting 4 spaces:
  • Marker character change forces new list start:
    • Ac tristique libero volutpat at
    • Facilisis in pretium nisl aliquet
    • Nulla volutpat aliquam velit
• Very easy!

Ordered

Numers in sequence

1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa

Numers not in sequence

1. You can use sequential numbers...
2. ...or keep all the numbers as 1.

Start numbering with offset:

57. foo
58. bar

---

Images

Like links, Images also have a footnote style syntax

With a reference later in the document defining the URL location:

---

Tables

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

---

Code

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));

---