{"id":19621328,"url":"https://github.com/commenthol/md-fileserver","last_synced_at":"2025-04-05T12:09:00.159Z","repository":{"id":18594201,"uuid":"21798835","full_name":"commenthol/md-fileserver","owner":"commenthol","description":"Locally view markdown files in a browser.","archived":false,"fork":false,"pushed_at":"2025-01-02T10:10:18.000Z","size":1883,"stargazers_count":82,"open_issues_count":5,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T11:11:21.194Z","etag":null,"topics":["markdown","viewer"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"WyriHaximus/react-guzzle-http-client","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/commenthol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-07-13T20:02:28.000Z","updated_at":"2025-01-27T19:34:35.000Z","dependencies_parsed_at":"2024-01-07T03:22:51.265Z","dependency_job_id":"8061c310-3448-46b7-85d8-eb3a78537696","html_url":"https://github.com/commenthol/md-fileserver","commit_stats":{"total_commits":112,"total_committers":2,"mean_commits":56.0,"dds":"0.017857142857142905","last_synced_commit":"b579ba10941c9e5fbd4166db49b34bb79ddeec2a"},"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commenthol%2Fmd-fileserver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commenthol%2Fmd-fileserver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commenthol%2Fmd-fileserver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commenthol%2Fmd-fileserver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/commenthol","download_url":"https://codeload.github.com/commenthol/md-fileserver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247332612,"owners_count":20921853,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","viewer"],"created_at":"2024-11-11T11:22:23.709Z","updated_at":"2025-04-05T12:09:00.134Z","avatar_url":"https://github.com/commenthol.png","language":"JavaScript","funding_links":[],"categories":["markdown","Markdown Building Blocks"],"sub_categories":["Markdown to Website / Blog"],"readme":"# md-fileserver\n\n\u003e Locally view markdown files in a browser.\n\n[![npm version](https://img.shields.io/npm/v/md-fileserver)](https://www.npmjs.com/package/md-fileserver/)\n[![Build Status](https://github.com/commenthol/md-fileserver/workflows/CI/badge.svg)](https://github.com/commenthol/md-fileserver/actions/workflows/ci.yml?query=branch%3Amaster)\n\nStarts a local server to render \"markdown\" files within your browser:\n\n- Runs on `localhost:4000`\n- Supports [Markdown Syntax][] with [GFM][].\n- Markdown rendering based on [markdown-it][].  \n  Enabled Plugins for:\n  - Emojis\n  - Task lists\n  - Footnotes\n  - [KaTeX][]\n  - [MultiMarkdown table syntax][]\n- Includes [markedpp][] as preprocessor.\n- Supports syntax highlighting using [highlight.js][]\n- For supported markdown syntax see [Cheatsheet][].\n- Automatic update in browser after saving edited file. (Tested on Linux, MacOS, Windows)\n- Support for [confluencer][]. Needs to be enabled in `/config`.\n\n## Table of Contents\n\n\u003c!-- !toc (minlevel=2 omit=\"Table of Contents\") --\u003e\n\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Start the Local Server](#start-the-local-server)\n  - [Open a markdown file](#open-a-markdown-file)\n- [Configuration](#configuration)\n- [Help](#help)\n- [Cheatsheet](#cheatsheet)\n- [Personalisation](#personalisation)\n- [Contribution](#contribution)\n- [License](#license)\n- [References](#references)\n\n\u003c!-- toc! --\u003e\n\n## Installation\n\n```bash\nnpm install -g md-fileserver\n```\n\n## Usage\n\n### Start the Local Server\n\nIn your terminal type:\n\n```\nmdstart\n```\n\nOpen the given link \u003chttp://localhost:4000/?session=...\u003e in your browser and\nnavigate to the markdown file.\n\n**Note**: The local server can only be reached from your local computer on port 4000.\nAny remote access from other computers to your files is denied.\nAn internal session is used, so you'll need to either start with a file or use the provided\nlink with the session parameter.\n\n### Open a markdown file\n\nType in your terminal:\n\n```\nmdstart \u003cfile.md\u003e\n```\n\nThis will open the default browser with the processed markdown file.\n\n## Configuration\n\n```\nmdstart /config\n```\n\n![](./man/config.jpg)\n\n## Help\n\n```\nmdstart --help\n```\n\nor\n\n```\nman mdstart\n```\n\n## Cheatsheet\n\n```\nmdstart /cheatsheet\n```\n\n[Cheatsheet][]\n\n## Personalisation\n\nIn `config.js` you can change several settings to fit your needs. These include:\n\n- **Browser**: Default browser of MacOS, Linux or Windows is used.\n- **Markdown** options: Change the options how [markdown-it][] processes your markdown files.\n- **Markdown PP** options: Change the options how [markedpp][] pre-processes your markdown files.\n\nInstall personalized version:\n\n1. Clone this repo\n\n   ```\n   git clone --depth 2 https://github.com/commenthol/md-fileserver.git\n   cd md-fileserver\n   ```\n\n2. Make your changes in `./config.js`\n3. Install with `npm i -g` from same folder.  \n   If there are issues with installing you'll need to uninstall first with `npm un -g`\n\n## Contribution\n\nIf you contribute code to this project, you are implicitly allowing your code\nto be distributed under the MIT license. You are also implicitly verifying that\nall code is your original work.\n\n## License\n\nCopyright (c) 2014-present commenthol  \nSoftware is released under [MIT License][].\n\nBundled fonts from [KaTeX][] by Khan Academy - https://github.com/Khan/KaTeX -\n[License](https://github.com/KaTeX/KaTeX/blob/master/LICENSE) (Fonts: SIL OFL 1.1, Code: MIT License)\n\n## References\n\n\u003c!-- !ref --\u003e\n\n- [Cheatsheet][Cheatsheet]\n- [confluencer][confluencer]\n- [GFM][GFM]\n- [highlight.js][highlight.js]\n- [KaTeX][KaTeX]\n- [Markdown Syntax][Markdown Syntax]\n- [markdown-it][markdown-it]\n- [markedpp][markedpp]\n- [MIT License][MIT License]\n- [MultiMarkdown table syntax][MultiMarkdown table syntax]\n\n\u003c!-- ref! --\u003e\n\n[KaTeX]: https://katex.org/\n[MultiMarkdown table syntax]: https://npmjs.com/package/markdown-it-multimd-table\n[confluencer]: https://npmjs.com/package/confluencer\n[Cheatsheet]: test/cheatsheet.md\n[GFM]: https://help.github.com/articles/github-flavored-markdown\n[highlight.js]: http://highlightjs.org\n[markdown-it]: https://github.com/markdown-it/markdown-it\n[markedpp]: https://github.com/commenthol/markedpp\n[Markdown Syntax]: http://daringfireball.net/projects/markdown/syntax\n[MIT License]: ./LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommenthol%2Fmd-fileserver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcommenthol%2Fmd-fileserver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommenthol%2Fmd-fileserver/lists"}