{"id":28404997,"url":"https://github.com/crisfeim/cli-swiftdown","last_synced_at":"2025-10-19T19:32:18.365Z","repository":{"id":292054724,"uuid":"979665928","full_name":"crisfeim/cli-swiftdown","owner":"crisfeim","description":"🛠️  A Swift-based article generator for technical writing in .swift files. Comments become prose. Code stays as code.","archived":false,"fork":false,"pushed_at":"2025-06-16T02:58:01.000Z","size":2544,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-16T04:15:04.679Z","etag":null,"topics":["code-documentation","static-site-generator","swift-cli","technical-writing"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crisfeim.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,"zenodo":null}},"created_at":"2025-05-07T21:56:29.000Z","updated_at":"2025-06-16T02:58:04.000Z","dependencies_parsed_at":"2025-05-08T01:45:40.544Z","dependency_job_id":null,"html_url":"https://github.com/crisfeim/cli-swiftdown","commit_stats":null,"previous_names":["crisrojas/swift-down","crisrojas/cli-swiftdown","crisfeim/cli-swiftdown"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/crisfeim/cli-swiftdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crisfeim%2Fcli-swiftdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crisfeim%2Fcli-swiftdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crisfeim%2Fcli-swiftdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crisfeim%2Fcli-swiftdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crisfeim","download_url":"https://codeload.github.com/crisfeim/cli-swiftdown/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crisfeim%2Fcli-swiftdown/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262535810,"owners_count":23325712,"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":["code-documentation","static-site-generator","swift-cli","technical-writing"],"created_at":"2025-06-01T21:10:10.679Z","updated_at":"2025-10-19T19:32:13.344Z","avatar_url":"https://github.com/crisfeim.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swiftdown\n\n![status: archived](https://img.shields.io/badge/status-archived-lightgrey.svg)\n![maintenance: inactive](https://img.shields.io/badge/maintenance-inactive-red.svg)\n![type: cli-tool](https://img.shields.io/badge/type-cli--tool-blue.svg)\n\n\u003e Because Markdown was too mainstream.\n\n**Swiftdown** lets you write entire technical articles using Swift files. Comments become prose. Code stays as code.\n\n![](swiftdown.png)\n\n## Motivation\n\nWriting in Markdown is fine. But for developers writing about Swift, it's disconnected. Swiftodwn keeps everything in the same medium:\n\n- Write and explain code using `//` comments.\n- Structure your article using code blocks.\n- Export to HTML in one command.\n\nAll within the comfort of a `.swift` file.\n\n## Features\n\n- `//` and `///` comments are treated as narrative content.\n- Code blocks are preserved with syntax highlighting.\n- Generates a standalone `.html` file (no assets or dependencies).\n- Command-line usage.\n\n## 📹 Demo\n\n\nhttps://github.com/user-attachments/assets/1558827f-cb87-45d3-92f6-f3ecb8680c7f\n\n\n## 📦 Installation\n\nClone this repo and build:\n\n```bash\ngit clone https://github.com/crisrojas/swiftdown\ncd swiftdown\nswift build -c release\n```\n\nThen add the binary to your path or use directly from .build/release/swiftdown.\n\n## Usage\n\nYou need to structure your project as follows:\n\n```\n|- your-swift-blog\n    |- sources  \n    |- theme\n```\n\nFor an example theme see `example` folder.\n\nThen pass it to the CLI\n\n```bash\n~ swiftdown build your-swift-blog\n```\n\nAlternatively, you can also serve the contents:\n\n```bash\n~ swiftdown serve your-swift-blog\n```\n\n## 🧑‍💻 Use Cases\n\n- Technical blog posts written entirely in Swift.\n- Annotated code walkthroughs.\n- Educational examples and tutorials.\n- Reproducible code + prose workflows for teams.\n\n## 🛣️ Roadmap\n\nThis project started as an experiment. I was tired of copy-pasting code from playgrounds into articles. I thought: why not write articles in Swift, using Swift itself?\n\nThe idea has merit, and some real utility, but also caveats.\n\nStill, Swiftdown is mostly feature-complete. If I ever revisit it, I’d like to add:\n- Export to self-contained .html articles `swiftdown Article.swift \u003e article.html`\n- Project navigation, displaying files and folders with their icons.\n\nAnd overall, a more Xcode-like look and feel. Imagine pointing it at your whole project and having it rendered — wouldn’t that be cool?\n\n## License\n\nMIT — You are free to use, modify, and distribute this project. Attribution is required.\n\n## Credits\n\n- Theme toggle styles adapted from [theme-toggles](https://github.com/AlfieJones/theme-toggles) by Alfred Jones — MIT License.\n- Syntax highlighting provided by [Splash](https://github.com/JohnSundell/Splash) by John Sundell.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrisfeim%2Fcli-swiftdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrisfeim%2Fcli-swiftdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrisfeim%2Fcli-swiftdown/lists"}