{"id":15933660,"url":"https://github.com/geopjr/vitepressify","last_synced_at":"2025-09-23T09:59:44.225Z","repository":{"id":58972072,"uuid":"534840133","full_name":"GeopJr/vitepressify","owner":"GeopJr","description":"💎🖖 Convert Crystal docs into VitePress","archived":false,"fork":false,"pushed_at":"2023-03-13T03:36:27.000Z","size":25,"stargazers_count":4,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-29T07:24:25.765Z","etag":null,"topics":["crystal","docs","documentation","vitepress"],"latest_commit_sha":null,"homepage":"","language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GeopJr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"github":"GeopJr","custom":["https://www.paypal.me/GeopJr","https://geopjr.dev/donate"]}},"created_at":"2022-09-09T23:50:19.000Z","updated_at":"2023-05-12T17:09:24.000Z","dependencies_parsed_at":"2025-03-24T20:43:07.936Z","dependency_job_id":null,"html_url":"https://github.com/GeopJr/vitepressify","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/GeopJr/vitepressify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeopJr%2Fvitepressify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeopJr%2Fvitepressify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeopJr%2Fvitepressify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeopJr%2Fvitepressify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GeopJr","download_url":"https://codeload.github.com/GeopJr/vitepressify/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeopJr%2Fvitepressify/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276554030,"owners_count":25662960,"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","status":"online","status_checked_at":"2025-09-23T02:00:09.130Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["crystal","docs","documentation","vitepress"],"created_at":"2024-10-07T02:41:29.133Z","updated_at":"2025-09-23T09:59:44.216Z","avatar_url":"https://github.com/GeopJr.png","language":"Crystal","funding_links":["https://github.com/sponsors/GeopJr","https://www.paypal.me/GeopJr","https://geopjr.dev/donate"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg height=\"256\" alt=\"vitepressify, a green rectangle behind a black rectangle that has the markdown logo on top in white\" src=\"./logo.svg\"\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003evitepressify\u003c/h1\u003e\n\u003ch4 align=\"center\"\u003eConvert Crystal docs into VitePress\u003c/h4\u003e\n\u003cp align=\"center\"\u003e\n  \u003cbr /\u003e\n    \u003ca href=\"https://github.com/GeopJr/vitepressify/blob/main/CODE_OF_CONDUCT.md\"\u003e\u003cimg src=\"https://img.shields.io/badge/Contributor%20Covenant-v2.1-000000.svg?style=for-the-badge\u0026labelColor=389d70\" alt=\"Code Of Conduct\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/GeopJr/vitepressify/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/LICENSE-BSD--2--Clause-000000.svg?style=for-the-badge\u0026labelColor=389d70\" alt=\"BSD-2-Clause\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/GeopJr/vitepressify/actions\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/GeopJr/vitepressify/ci.yml?labelColor=389d70\u0026style=for-the-badge\u0026branch=main\" alt=\"ci action status\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## What is vitepressify?\n\nCrystal docs are awesome, but sometimes you need more control over them.\n\nvitepressify generates a VitePress project with pages from your local or remote Crystal docs.\n\n- It automatically generates markdown pages and sidebars.\n- It provides a table of contents.\n- It can update an already made project with more versions or other shards.\n- It automatically handles loading sidebars and cases where navbar has 1 vs more items, without the need to overwrite any configs.\n- It comes with a purple accent.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg width=\"1024\" src=\"https://i.imgur.com/XsauHgY.png\" alt=\"Screenshot of VitePress docs of Crystal-lang api docs. Screenshot is split diagonally showcasing both dark and light themes.\" /\u003e\n\u003c/p\u003e\n\n## Installation\n\n### Pre-built\n\nYou can download one of the statically-linked pre-built binaries from the [releases page](https://github.com/GeopJr/vitepressify/releases/latest).\n\nThey are built \u0026 published by our lovely [actions](https://github.com/GeopJr/vitepressify/actions/workflows/release.yml).\n\n### Building\n\n#### Dependencies\n\n- `crystal` - `1.7.3`\n\n#### Manually\n\n`$ shards build --production --no-debug --release`\n\n## Usage\n\n```\nVitepressify v1.0.0\nUsage:\n    vitepressify [arguments]\nExamples:\n    vitepressify -i ./docs/index.json\n    vitepressify -i https://crystal-lang.org/api/1.5.0/ -t 1.5.0\n    vitepressify -i https://geopjr.github.io/gettext.cr/index.json -u ./vitepressify-docs\n\nArguments:\n    -i INDEX, --index=INDEX          index.json location. Can be either a local path or a url (e.g. https://libadwaita.geopjr.dev/docs/). Default: ./docs/index.json\n    -t TAG, --tag=TAG                Current release/tag (e.g. 1.0.0). Default: main\n    -u FOLDER, --update=FOLDER       Instead of generating a new project, it attempts to update the one at FOLDER.\n    -l, --license                    Show the LICENSE\n    -h, --help                       Show this help\n```\n\n## Example\n\nIf you wanted for example to build a VitePress project using the Crystal API docs from 1.4.0 to 1.5.1, all you have to do is:\n\n- Generate the initial project, using the link to the 1.5.1 docs with the tag of `1.5.1`.\n\n```bash\n$ vitepressify -i https://crystal-lang.org/api/1.5.1/ -t 1.5.1\n```\n\nThis will generate the project in a random named folder, for example `vitepress-ujqywe`.\n\n- Now we just tell `vitepressify` to update that folder with the other versions:\n\n```bash\n$ vitepressify -i https://crystal-lang.org/api/1.5.0/ -t 1.5.0 -u ./vitepress-ujqywe/\n\n$ vitepressify -i https://crystal-lang.org/api/1.4.1/ -t 1.4.1 -u ./vitepress-ujqywe/\n\n$ vitepressify -i https://crystal-lang.org/api/1.4.0/ -t 1.4.0 -u ./vitepress-ujqywe/\n```\n\n- And we are done!\n\n## Contributing\n\n1. Read the [Code of Conduct](./CODE_OF_CONDUCT.md)\n2. Fork it (\u003chttps://github.com/GeopJr/vitepressify/fork\u003e)\n3. Create your feature branch (`git checkout -b my-new-feature`)\n4. Commit your changes (`git commit -am 'Add some feature'`)\n5. Push to the branch (`git push origin my-new-feature`)\n6. Create a new Pull Request\n\n## Sponsors\n\n\u003cp align=\"center\"\u003e\n\n[![GeopJr Sponsors](https://cdn.jsdelivr.net/gh/GeopJr/GeopJr@main/sponsors.svg)](https://github.com/sponsors/GeopJr)\n\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeopjr%2Fvitepressify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeopjr%2Fvitepressify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeopjr%2Fvitepressify/lists"}