Readme.md

About

md2smint tries to convert a markdown based file into a one page html file for SMINT.

Screenshot

⇑⇑⇑

HowTo

• IN: the markdown file Markdown in and the checkbuttons

• OUT: the HTML-file HTML out will be generated using the template file md2smint.temp in the subdirectory template.

• _in2out_: takeover the Markdown in file name for the HTML out file name. The extension will be *.html.

• The SubMenu comes from the page titles.

⇑⇑⇑

Markdown - Extensions

• Markdown - Extensions for sections
  • ---   → three dashes to separate sections
  • Underline with === for the title of the one page html file (→ title-tag)

⇑⇑⇑

Examples

See this README for more Information.

⇑⇑⇑

config.json

You can edit and change the markdown extensions configuration in the JSON-file config.json
md2smint try to read the markdown file name from the config.json, see the line
"mdFileName": "README.md"
md2smint generates a project-specific json-file for the Header, the Subheader and the Footer, see for example the file README.json.
You should edit this file for your own needs.

• Note: Don't use any special characters in json-files!

⇑⇑⇑

Checkbuttons

• MathJax: Support for MathJax (→ LaTeX-like Math-Formula).
  • Note: The Download of MathJax.js increases the load time.

• Showdown: Support for the JavaScript Markdown-Parser Showdown

• hr: A horizontal rule between the sections.

⇑⇑⇑

Notes

• The proper use of md2smint is based on the Python-Markdown module, which has to be installed first. Python-Markdown is a Python implementation of John Gruber’s Markdown.

• md2smint is a python 2.7.x-script . . .

⇑⇑⇑

License

Copyright (C) 2018 Walter Spiegel

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

⇑⇑⇑

Mail

• sp, 2018-12-09, Vers. 008 – md2smint

• Mail: walter [dot] spiegel [at] web [dot] de

⇑⇑⇑