{"id":16483459,"url":"https://github.com/dbohdan/caddy-markdown-site","last_synced_at":"2025-10-29T04:12:46.597Z","repository":{"id":68307336,"uuid":"381278845","full_name":"dbohdan/caddy-markdown-site","owner":"dbohdan","description":"Serve Markdown files as HTML pages with CSS using just Caddy","archived":false,"fork":false,"pushed_at":"2024-09-08T09:06:01.000Z","size":558,"stargazers_count":55,"open_issues_count":0,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-27T12:14:18.306Z","etag":null,"topics":["caddy","caddyserver","markdown"],"latest_commit_sha":null,"homepage":"","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/dbohdan.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":"2021-06-29T07:35:39.000Z","updated_at":"2025-01-24T17:34:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"e01735ea-4d0d-4ced-be51-de44a58925c9","html_url":"https://github.com/dbohdan/caddy-markdown-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbohdan%2Fcaddy-markdown-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbohdan%2Fcaddy-markdown-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbohdan%2Fcaddy-markdown-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbohdan%2Fcaddy-markdown-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dbohdan","download_url":"https://codeload.github.com/dbohdan/caddy-markdown-site/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243826783,"owners_count":20354220,"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":["caddy","caddyserver","markdown"],"created_at":"2024-10-11T13:14:05.378Z","updated_at":"2025-10-29T04:12:41.572Z","avatar_url":"https://github.com/dbohdan.png","language":"CSS","funding_links":[],"categories":["CSS"],"sub_categories":[],"readme":"# caddy-markdown-site\n\nThis project is a proof of concept showing how you can serve Markdown files\nas reasonably good-looking minimal web pages\nwith just the [Caddy](https://caddyserver.com/) web server.\nIt is not a static site generator; there is no build step.\nThe project consists of a Caddy configuration file (Caddyfile), HTML [templates](https://caddyserver.com/docs/caddyfile/directives/templates), and CSS files.\nYou will need some knowledge of Caddy to use and customize the project.\nExpect a lot of work, and possibly insurmountable barriers, if you decide to adapt it for anything but a simple website.\n\n\n## Screenshot\n\n![A screenshot the index page of the demo website.](screenshot.png)\n\n\n## Requirements\n\n- Caddy 2.4 or later.\n- Optional:\n    - [Deno](https://deno.land/) 1.31 or later to run the [tests](test.ts)\n      (`just test`).\n    - [entr](https://github.com/eradman/entr) for development\n      (`just dev`).\n    - [just](https://github.com/casey/just) to run the tasks.\n\n\n## Features\n\n- If your page file is `demo/foo.md` and your domain example.com,\n  you will be able to access the file as example.com/foo with no extension and example.com/foo.md.\n- `index.md` serves as the directory index (but `index.html` takes priority).\n- You can customize the look of your site without touching the main template.\n  Edit `templates/{head,header,footer}.html` to do it.\n  `head.html` links to the style sheets.\n- An error page is shown on error.\n\n\n## Front matter\n\nMarkdown page files can include Caddy template\n[front matter](https://caddyserver.com/docs/modules/http.handlers.templates#splitfrontmatter)\nin JSON, TOML, or YAML.\nThe front matter sets variables that configure how a page is presented.\n\nThe following variables are recognized:\n\n- `lang`: the [`lang`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) HTML global attribute.\n  If not specified, defaults to an empty string.\n- `text_dir`: the [`dir`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) HTML global attribute.\n  Defaults to `auto`.\n- `title`: The page title.\n  Defaults to the request path.\n\n### Example\n\n```none\n---\nlang: en\ntitle: Greeting\n---\nHello, world!\n```\n\n\n## License\n\nMIT.\n\n[`index.html`](templates/index.html) derives from the\n[`index.html` template](https://github.com/caddyserver/website/blob/1ff5103c73c921c8faa82ef3342d904a7f6a8e22/src/docs/index.html) used on the Caddy website.\n\n[`axist.css`](templates/axist.css) is [axist](https://github.com/ruanmartinelli/axist),\na [classless](https://github.com/dbohdan/classless-css) CSS stylesheet.\n\n[`photo.jpg`](demo/media/photo.jpg) is by Siarhei Plashchynski\n[on Unsplash](https://unsplash.com/photos/6FmtLICCvxI).\n\n\u003e Unsplash grants you an irrevocable, nonexclusive, worldwide copyright license\n\u003e to download, copy, modify, distribute, perform, and use photos from Unsplash for free,\n\u003e including for commercial purposes, without permission from or attributing the photographer or Unsplash.\n\u003e This license does not include the right to compile photos from Unsplash\n\u003e to replicate a similar or competing service.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbohdan%2Fcaddy-markdown-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdbohdan%2Fcaddy-markdown-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbohdan%2Fcaddy-markdown-site/lists"}