{"repo":"vimtaai/gumdrop","free":true,"listed":false,"github":"https://github.com/vimtaai/gumdrop","clone":"git clone https://github.com/vimtaai/gumdrop.git","description":"Script to display Markdown documents as static HTML pages","language":"JavaScript","stars":10,"topics":["static-site","markdown","serverless","mustache","extramark"],"license":"MIT","category":"productivity","readme_excerpt":"Gumdrop [![Version][badge-version]](https://www.npmjs.com/package/gumdrop) [![License][badge-license]](https://github.com/vimtaai/gumdrop/blob/master/LICENSE.md) [![Code style][badge-style]](https://github.com/prettier/prettier) Zero-configuration script to display Markdown documents as static HTML pages Gumdrop is designed to be an easy to use, standalone script that can generate websites and documentations written in Markdown. It dinamically loads all its dependencies from a CDN (including the Markdown parser) and does not require any configuration or initialization. Installation Gumdrop does not require installation you just have to load it into an HTML document with a script tag. Usage To create a static website with Markdown all you need to to is to create a HTML template ( index.html ) on your file server and add Gumdrop as an external script file. Be aware, that you have to serve your files via http / https protocol, as the file protocol does not support fetch requests. Markdown files in the pages folder can be loaded. Gumdrop watches the hash fragment of the URL and loads the corresponding Markdown file from the pages folder. The parsed Markdown files get rendered in the HTML node if present, in body otherwise. The default file that gets loaded if no file is specified is pages/index.md . To create a link to another file in the pages folder simply create a link with its name prefixed by #!/ . Static resources (e.g. images) can be loaded from any folder that is served b","default_branch":null,"files":null,"tree":[],"storefront":"/r/vimtaai","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/vimtaai/gumdrop/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}