diff --git a/README.md b/README.md new file mode 100644 index 0000000..a14857c --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# MDLinks # + +MDLinks is a static HTML page with JS markdown parser. It creates a link portal page with the links in a markdown file. + +## Configuration + +* config.js + * File is read to replace values in "config.xx" object. + * config.style='path_to_style.css'; + * config.title='Title of page'; + * config.columns=[integer]; // Split heads to this many columns + * config.search=true; // Display link search bar + * config.favicon='path_to_favicon.ico'; + +## Markdown + +Only 1st level heads and links are parsed. The rest are printed as is: +``` +# header + +[link name](link url) + +``` \ No newline at end of file