{"id":20302170,"url":"https://github.com/tantalic/servemd","last_synced_at":"2026-04-11T00:54:16.990Z","repository":{"id":69704472,"uuid":"57428425","full_name":"tantalic/servemd","owner":"tantalic","description":"A simple HTTP server for markdown content","archived":false,"fork":false,"pushed_at":"2018-05-27T04:53:26.000Z","size":788,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-14T10:57:23.466Z","etag":null,"topics":["docker-container","markdown","server"],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/tantalic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2016-04-30T05:22:31.000Z","updated_at":"2018-05-27T04:53:27.000Z","dependencies_parsed_at":"2023-07-11T05:34:00.965Z","dependency_job_id":null,"html_url":"https://github.com/tantalic/servemd","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/tantalic%2Fservemd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tantalic%2Fservemd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tantalic%2Fservemd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tantalic%2Fservemd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tantalic","download_url":"https://codeload.github.com/tantalic/servemd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241801194,"owners_count":20022383,"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":["docker-container","markdown","server"],"created_at":"2024-11-14T16:29:30.003Z","updated_at":"2025-12-31T01:03:15.014Z","avatar_url":"https://github.com/tantalic.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `servemd`\n\nServemd makes it simple and fast to serve one or more [markdown][markdown] files without the build process required by static site generators. Servemd can be used for quick local viewing or to serve content to thousands of visitors.\n\n## Installation\n\nServemd is distributed as either:\n\n- An executable with no dependencies\n- A docker image\n\n### Executable\n\nServemd is a single executable with no dependencies. Installation is as simple as downloading the binary for your platform from the [release page][release]. Releases are made available for:\n\n- Mac OS X (x86, x64)\n- Linux (x86, x64, ARMv5, ARMv6, ARMv7, ARMv8)\n- FreeBSD (x86, x64, ARMv5, ARMv6, ARMv7)\n- NetBSD (x86, x64, ARMv5, ARMv6, ARMv7)\n- DragonFly BSD (x64)\n- Windows (x86, x64)\n\nOS X users can install `servemd` using the [Homebrew package manager][homebrew]:\n\n```shell\nbrew tap tantalic/tap\nbrew install servemd\n```\n\n### Docker\n\nThe [tantalic/servemd][dockerhub] image can be pulled from Docker Hub:\n\n```shell\ndocker pull tantalic/servemd\n```\n\n## Configuration\n\nUsage: `servemd [OPTIONS] [DIR]`\n\n### Arguments\n\n| Environment Variable | Argument |           Description            | Default Value |\n|----------------------|----------|----------------------------------|---------------|\n| `DOCUMENT_ROOT`      | `[DIR]`  | Directory to serve content from. | `.`           |\n\n### Flags\n\n| Environment Variable |          Flag          |                                                                         Description                                                                         | Default Value |\n|----------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|\n| `HOST`               | `-a, --host`           | Host/IP address to listen on                                                                                                                                | All addresses |\n| `PORT`               | `-p, --port`           | TCP port to listen on                                                                                                                                       | `3000`        |\n| `BASIC_AUTH`         | `-u, --auth`           | Username and password for HTTP basic authentication. In the form of `user1:pass1,user2:pass2`                                                               | None          |\n| `X_ROBOTS_TAG`       | `-r --x-robots-tag`    | Sets a `X-Robots-Tag` header. Example: `\"noindex, nofollow\"`                                                                                                | None          |\n| `DOCUMENT_EXTENSION` | `-e, --extension`      | Extension used for markdown files                                                                                                                           | `.md`         |\n| `DIRECTORY_INDEX`    | `-i, --index`          | Filename (without extension) to use for directory indexes                                                                                                   | `index`       |\n| `MARKDOWN_THEME`     | `-m, --markdown-theme` | Theme to use for styling markdown. Can be one of the following built-in themes: *clean*, *github*, *developer* or the path to a custom CSS file to include. | `clean`       |\n| `TYPEKIT_KIT_ID`     | `-t, --typekit-kit-id` | Kit ID to include webfonts from the Typekit service. For use alongside a custom markdown theme.                                                             |               |\n| `CODE_THEME`         | `-c, --code-theme`     | Syntax highlighting theme (powered by [highlight.js][highlightjs])                                                                                          | None          |\n\n\n## Deploying with Docker \n\nThe [tantalic/servemd][dockerhub] image can be used as a base for deployment. To create an image simply add your content to `/app/content` and configure via environment variables in your `Dockerfile`:\n\n```Dockerfile\nFROM tantalic/servemd:latest\nMAINTAINER Your Name \u003cemail@example.com\u003e\n\nENV MARKDOWN_THEME developer\nENV CODE_THEME solarized-dark\n\nADD content /content\n```\n\n\n[markdown]: https://daringfireball.net/projects/markdown/syntax\n[release]: https://github.com/tantalic/servemd/releases/latest\n[homebrew]: http://brew.sh\n[highlightjs]: http://highlightjs.org\n[dockerhub]: https://hub.docker.com/r/tantalic/servemd/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftantalic%2Fservemd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftantalic%2Fservemd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftantalic%2Fservemd/lists"}