{"id":13823450,"url":"https://github.com/aerth/markdownd","last_synced_at":"2025-07-08T17:33:40.724Z","repository":{"id":57500907,"uuid":"90673089","full_name":"aerth/markdownd","owner":"aerth","description":"simple markdown server (optional indexing, no symlinks) report bugs: https://github.com/aerth/markdownd/issues (Heroku takes a couple seconds to load. Patience...)","archived":false,"fork":false,"pushed_at":"2023-03-07T01:58:37.000Z","size":332,"stargazers_count":144,"open_issues_count":4,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-08-04T09:01:23.414Z","etag":null,"topics":["html","markdown","markdown-convertor","server"],"latest_commit_sha":null,"homepage":"https://markdownd.herokuapp.com/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aerth.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2017-05-08T21:15:13.000Z","updated_at":"2024-01-04T16:13:52.000Z","dependencies_parsed_at":"2024-01-15T16:52:42.097Z","dependency_job_id":null,"html_url":"https://github.com/aerth/markdownd","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerth%2Fmarkdownd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerth%2Fmarkdownd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerth%2Fmarkdownd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aerth%2Fmarkdownd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aerth","download_url":"https://codeload.github.com/aerth/markdownd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225453328,"owners_count":17476702,"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":["html","markdown","markdown-convertor","server"],"created_at":"2024-08-04T09:00:34.648Z","updated_at":"2024-11-20T01:30:33.473Z","avatar_url":"https://github.com/aerth.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"![markdownd](https://github.com/aerth/markdownd/blob/master/docs/markdownd.png?raw=true)\n\n`markdownd [flags] \u003cdirectory\u003e`\n\n`markdownd -toc -header theme/header.html -footer theme/footer.html .`\n\n`markdownd -index=gen .`\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/aerth/markdownd)](https://goreportcard.com/report/github.com/aerth/markdownd) \n[![Build Status](https://travis-ci.org/aerth/markdownd.svg?branch=master)](https://travis-ci.org/aerth/markdownd) \n\n## Markdown Server\n\n  * tries markdown file (.md) in .html request (/index.html tries /index.md first)\n  * will serve .html if exists\n  * serves static files and downloads if not .html or .md\n  * optional indexing (default: off, use -index=gen or -index=README.md)\n  * no symlinks\n  * no `../` paths\n  * raw markdown source requests ( example: `GET /index.md?raw` )\n  * custom index page (use flag: `-index README.md`)\n  * generates table of contents with `-toc` flag\n  * themed html with `-header` and `-footer` flag\n  * now with syntax highlighting (use flag: `-syntax`)\n\n## Usage\n\n  * `GET /` will show a 404 unless -index flag is used (-index=gen to generate)\n  * `GET /README.md` or `GET /README.html` will process the markdown file and serve HTML.\n  * `GET /README.md?raw` will serve raw markdown source\n  * To generate index page (with links to files), use `-index=gen`\n  * To serve custom `index.md`, use `-index=index.md`\n\n#### Example use case: live preview your git repository's README.md\n\nFrom your project repository that contains a README.md file, run markdownd like so:\n\n```\nmarkdownd -index=README.md .\n```\n\nAnd visit http://localhost:8080/ in your browser\n\n## Installation\n\n### Compile using Go (from any directory)\n\n```\ngit clone https://github.com/aerth/markdownd\ncd markdownd\nmake \u0026\u0026 sudo make install\n```\n\nIf you don't want to install the server system-wide, or you don't have root privileges, replace last line with:\n\n```\nmake \u0026\u0026 make install INSTALLDIR=$HOME/bin\n```\n\n### Or using legacy go get\n\n```\nGOFLAGS=-tags=netgo,osusergo GOBIN=$HOME/bin go get -v github.com/aerth/markdownd\n```\n\n### Download binary for your OS (old versions)\n\n[Latest Release](https://github.com/aerth/markdownd/releases/latest)\n\nConsider installing [go](https://golang.org/dl) and building from source,\nIts fast and easy.\n\n## Docker\n\nWhen using the docker image, markdownd servest the /opt directory,\nand exposes port 8080.\n\nYou will want to share a directory into /opt and forward the port\n(using docker's `-v` and `-p` flags).\n\nFor example (modify `$PWD/docs` and `8888` to suit your needs):\n\n`docker run -it -v $PWD/docs:/opt -p 8888:8080 aerth/markdownd`\n\n## Free and Open Source\n\n\tThe MIT License (MIT)\n\t\n\tCopyright (c) 2017-2020  aerth \u003caerth@riseup.net\u003e\n\t\n\tPermission is hereby granted, free of charge, to any person obtaining a \n\tcopy of this software and associated documentation files (the \n\t\"Software\"), to deal in the Software without restriction, including \n\twithout limitation the rights to use, copy, modify, merge, publish, \n\tdistribute, sublicense, and/or sell copies of the Software, and to \n\tpermit persons to whom the Software is furnished to do so, subject to \n\tthe following conditions:\n\t\n\tThe above copyright notice and this permission notice shall be included \n\tin all copies or substantial portions of the Software.\n\t\n\tTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS \n\tOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF \n\tMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. \n\tIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY \n\tCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, \n\tTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE \n\tSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\t\n## Contributing:\n\n  * pull requests welcome\n  * bugs/issues/features very welcome\n  * please 'gofmt -w -l -s' before commits\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faerth%2Fmarkdownd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faerth%2Fmarkdownd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faerth%2Fmarkdownd/lists"}