{"id":25932397,"url":"https://github.com/intellicode/mdserve","last_synced_at":"2026-02-17T14:31:45.436Z","repository":{"id":279863583,"uuid":"940230362","full_name":"Intellicode/mdserve","owner":"Intellicode","description":"Rust Markdown Server","archived":false,"fork":false,"pushed_at":"2025-04-08T20:02:40.000Z","size":225,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-23T01:04:42.878Z","etag":null,"topics":["http-server","markdown","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/Intellicode.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-27T20:31:26.000Z","updated_at":"2025-04-08T20:02:33.000Z","dependencies_parsed_at":"2025-04-02T20:26:47.274Z","dependency_job_id":"b6029c33-568f-4b91-9d1e-8d4d98a8f55b","html_url":"https://github.com/Intellicode/mdserve","commit_stats":null,"previous_names":["intellicode/mdserve"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/Intellicode/mdserve","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Intellicode%2Fmdserve","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Intellicode%2Fmdserve/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Intellicode%2Fmdserve/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Intellicode%2Fmdserve/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Intellicode","download_url":"https://codeload.github.com/Intellicode/mdserve/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Intellicode%2Fmdserve/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261392077,"owners_count":23151715,"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":["http-server","markdown","rust"],"created_at":"2025-03-04T00:37:21.356Z","updated_at":"2026-02-17T14:31:45.429Z","avatar_url":"https://github.com/Intellicode.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003e🚀 Markdown Server\u003c/h1\u003e\n  \u003cp\u003eA fast and lightweight server that serves markdown files as HTML pages with beautiful typography.\u003c/p\u003e\n\u003c/div\u003e\n\n## Example\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"docs/screenshot.png\" alt=\"Markdown Server Screenshot\" width=\"500\" /\u003e\n\u003c/div\u003e\n\n## Features\n\n- 📝 GitHub Flavored Markdown support\n- 🎨 Beautiful typography with Source Serif font\n- 📁 Serves static files alongside markdown\n- 📱 Responsive design\n- 🔍 Automatic index.md rendering\n- 🛠️ Customizable with YAML configuration\n- ⚡ Built with Rust for maximum performance\n\n## Installation\n\n```bash\n# Clone the repository\ngit clone https://github.com/yourusername/markdown-server\ncd markdown-server\n\n# Build the project\ncargo build --release\n\n# Run the server\ncargo run --release -- /path/to/your/markdown/files\n```\n\n## Usage\n\n### Starting the Server\n\n```bash\n# With configuration file (required)\ncargo run -- serve --config /path/to/config.yaml\n\n# Backward compatibility mode\ncargo run -- --config /path/to/config.yaml\n```\n\n### Exporting Static HTML\n\n```bash\n# Export markdown to HTML (config required)\ncargo run -- export --output-dir /path/to/html --config /path/to/config.yaml\n```\n\n### Directory Structure\n\n```\ndocs/\n├── index.md # Served at /\n├── guide.md # Served at /guide\n└── tutorials/\n    ├── index.md # Served at /tutorials/\n    └── basics.md # Served at /tutorials/basics\n```\n\n### Supported Markdown Features\n\n- Headers (h1-h6)\n- Lists (ordered and unordered)\n- Code blocks with syntax highlighting\n- Tables\n- Task lists\n- Blockquotes\n- Links and images\n- Strikethrough\n- And more!\n\n## Configuration\n\n### Environment Variables\n\n- `PORT`: Server port (default: 3000)\n\n### Template Variables\n\nWhen creating a custom template, the following variables are available:\n\n- `{{content}}` - The markdown content converted to HTML\n- `{{title}}` - Page title from frontmatter's `title` field (default: \"Markdown Viewer\")\n- `{{header_title}}` - Header title from frontmatter's `title` field (default: \"Wiki\")\n- `{{description}}` - Description from frontmatter's `description` field (default: \"Markdown document\")\n- `{{frontmatter_block}}` - HTML block with formatted frontmatter information (author, date, description, tags)\n- `{{navigation_links}}` - Navigation links from the configuration file (or default links if not provided)\n\n### YAML Configuration File\n\nYou can customize the appearance and content of your markdown site using a YAML configuration file. Here's an example:\n\n```yaml\n# Source directory for markdown files (required)\nsource_dir: \"/path/to/your/markdown/files\"\n\n# Template directory for HTML templates (optional, default: \"./templates\")\ntemplate_dir: \"/path/to/templates\"\n\n# Custom CSS to be injected into the HTML page\ncustom_css: |\n  body {\n    max-width: 85ch;  /* Wider content area */\n  }\n\n  h1, h2, h3 {\n    color: #1e5285;  /* Custom heading colors */\n  }\n\n# Custom HTML content for the page header\nheader: |\n  \u003cdiv style=\"text-align: center; padding: 20px;\"\u003e\n    \u003cimg src=\"/logo.png\" alt=\"Logo\" height=\"60\"\u003e\n  \u003c/div\u003e\n\n# Custom HTML content for the page footer\nfooter: |\n  \u003cdiv style=\"text-align: center; margin-top: 30px;\"\u003e\n    \u003cp\u003e© 2025 Your Organization\u003c/p\u003e\n  \u003c/div\u003e\n\n# Navigation links to be displayed in the header\nnavigation:\n  - text: Home\n    url: /\n  - text: Documentation\n    url: /docs\n  - text: GitHub\n    url: https://github.com/intellicode/mdserve\n```\n\n## Development\n\n```bash\n# Run tests\ncargo test\n\n# Run with hot reloading\ncargo watch -x run -- /path/to/docs\n\n# Check formatting\ncargo fmt -- --check\n\n# Run linter\ncargo clippy\n```\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Security\n### Binary Verification\nAll official release binaries are signed using [Sigstore](https://sigstore.dev/), which provides keyless signing and verification. This allows you to verify that the binaries were built and signed as part of our official GitHub Actions release process.\n\n#### Verifying a Binary\n\nTo verify a binary:\n\n1. Install the Sigstore CLI:\n   ```bash\n   brew install cosign\n   ```\n\n2. Download the binary and its signature files:\n   Visit the [Releases](https://github.com/Intellicode/mdserve/releases) page to download the binary for your platform along with sigstore bundle.\n\n3. Verify the signature:\n   ```bash\n   cosign verify-blob mdserve-darwin-arm64 \\\n   --bundle mdserve-darwin-arm64.sigstore.json \\\n   --certificate-identity \"https://github.com/Intellicode/mdserve/.github/workflows/rust.yml@refs/tags/v0.5.3\" \\\n   --certificate-oidc-issuer  \"https://token.actions.githubusercontent.com\"\n   ```\n\nThis verification ensures that the binary was signed by the official GitHub Actions workflow during the release process.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintellicode%2Fmdserve","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintellicode%2Fmdserve","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintellicode%2Fmdserve/lists"}