{"repo":"commenthol/md-fileserver","free":true,"listed":false,"github":"https://github.com/commenthol/md-fileserver","clone":"git clone https://github.com/commenthol/md-fileserver.git","description":"Locally view markdown files in a browser.","language":"JavaScript","stars":102,"topics":["markdown","viewer"],"license":null,"category":"productivity","readme_excerpt":"md-fileserver Locally view markdown files in a browser. Starts a local server to render \"markdown\" files within your browser: - Runs on localhost:4000 - Supports [Markdown Syntax][] with [GFM][]. - Markdown rendering based on [markdown-it][]. Enabled Plugins for: - Emojis - Task lists - Footnotes - [KaTeX][] - [MultiMarkdown table syntax][] - Includes [markedpp][] as preprocessor. - Supports syntax highlighting using [highlight.js][] - For supported markdown syntax see [Cheatsheet][]. - Automatic update in browser after saving edited file. (Tested on Linux, MacOS, Windows) - Support for [confluencer][]. Needs to be enabled in /config . Table of Contents - Installation - Usage - Start the Local Server - Open a markdown file - Configuration - Help - Cheatsheet - Personalisation - Contribution - License - References Installation Usage Start the Local Server In your terminal type: Open the given link in your browser and navigate to the markdown file. Note : The local server can only be reached from your local computer on port 4000. Any remote access from other computers to your files is denied. An internal session is used, so you'll need to either start with a file or use the provided link with the session parameter. Open a markdown file Type in your terminal: This will open the default browser with the processed markdown file. Configuration Help or Cheatsheet [Cheatsheet][] Personalisation In config.js you can change several settings to fit your needs. These include: - Browser :","default_branch":null,"files":null,"tree":[],"storefront":"/r/commenthol","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/commenthol/md-fileserver/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."}