janis-rullis / md-helpers

Scripts, samples, tips for writing MarkDown documents.

MD Editors

• ReText
• Caret

mdpr

Preview MarkDown files from terminal using ReText.

Ctrl + E - Switch the Preview / Edit mode.

md-nav-gen

Generate a navigation bar.

-----------------------------------------------------------------------------------
### / [shell-scripts](../) / [md-nav-gen](.)
-----------------------------------------------------------------------------------

md-ls-gen

Generate links to files inside this directory.

* [docs](./docs)
* [how-to](./docs/how-to)

md-tree-gen

Generate links to files inside this directory and below.

 * [docs](./docs)
   * [how-to](./docs/how-to)
   * [serve.md](./docs/how-to/serve.md)
 * [Tree.md](./Tree.md)
 * [README.md](./README.md)
 * [md-tree-gen.sh](./md-tree-gen.sh)

md-img-gen

Include all images from all directories below in the format of Markdown.

#### 1/2/3/apply canvas
![1/2/3/apply canvas](1/2/3/apply-canvas.png)

#### 1/2/3/rippling
![1/2/3/rippling](1/2/3/rippling.png)

#### 1/orig 250x
![1/orig 250x](1/orig-250x.jpg)

Sample of links formated like a header menu

## [Home](Home/) | [Products](Products/) | [Gallery](Gallery/) | [Partners](Partners/) | Projects | [About us](About-us/) | [Contacts](Contacts/)

Random tips

Images

• I've found that the perfect size for an image in Markdown docs, is when one of the dimensions (width or height) is 250-300px. Example.