{"id":17975471,"url":"https://github.com/andreiborisov/dash-fish","last_synced_at":"2025-04-04T00:13:26.063Z","repository":{"id":225997705,"uuid":"264083601","full_name":"andreiborisov/dash-fish","owner":"andreiborisov","description":"📖 Generate a Dash docset for the fish shell","archived":false,"fork":false,"pushed_at":"2021-07-07T11:31:39.000Z","size":4076,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-09T11:43:32.787Z","etag":null,"topics":["dash-docset","fish"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/andreiborisov.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}},"created_at":"2020-05-15T03:11:23.000Z","updated_at":"2024-05-02T07:00:56.000Z","dependencies_parsed_at":"2024-03-05T11:50:15.896Z","dependency_job_id":null,"html_url":"https://github.com/andreiborisov/dash-fish","commit_stats":null,"previous_names":["andreiborisov/dash-fish"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreiborisov%2Fdash-fish","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreiborisov%2Fdash-fish/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreiborisov%2Fdash-fish/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreiborisov%2Fdash-fish/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andreiborisov","download_url":"https://codeload.github.com/andreiborisov/dash-fish/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247098001,"owners_count":20883129,"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":["dash-docset","fish"],"created_at":"2024-10-29T17:19:43.035Z","updated_at":"2025-04-04T00:13:26.046Z","avatar_url":"https://github.com/andreiborisov.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dash-fish\n\ndash-fish is a toolchain for the generation of a [Dash](https://kapeli.com/dash) docset for the [fish shell](http://fishshell.com). It uses [Sphinx](https://www.sphinx-doc.org) to build HTML documentation from the source and [Dashing](https://github.com/technosophos/dashing) to generate the docset from it.\n\n## Installation\n\nClone the repo with git:\n\n```shell\ngit clone git@github.com:andreiborisov/dash-fish.git\n```\n\n### System requirements\n\nInstall the dependencies with [Homebrew](https://brew.sh) (recommended):\n\n```shell\nbrew bundle\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eNot using Homebrew?\u003c/summary\u003e\n\n- - -\n\ndash-fish requires:\n\n* git 2.24+\n* [git filter-repo](https://github.com/newren/git-filter-repo) 2.26+\n* [Sphinx](https://www.sphinx-doc.org) 3+\n* [Dashing](https://github.com/technosophos/dashing) 0.4+\n\n\u003c/details\u003e\n\n## Usage\n\nTo generate the docset, run:\n\n```shell\nmake build\n```\n\nThis produces both the `fish.docset` itself and its archived version for submitting it to [Dash user contributions](https://github.com/Kapeli/Dash-User-Contributions).\n\n- - -\n\ndash-fish integrates docs source from [fish shell repo](https://github.com/fish-shell/fish-shell) in order to customise the Sphinx build by stripping out unnecessary elements.\n\nTo grab fresh commits from the upstream run:\n\n```shell\nmake fetch_subtree\n```\n\nThis will clone fish shell repo into a temporary folder, filter out unrelated commits and add related ones via git subtree. You can merge or rebase main branch after that and rebuild the docset:\n\n```shell\ngit rebase fish-shell main\nmake build\n```\n\nTo clean the working directory from build artifacts, run:\n\n```shell\nmake clean\n```\n\n## License\n\ndash-fish is licensed under the [MIT License](LICENSE).\n\nfish shell docs and icon are licensed under the [GNU General Public License, version 2](https://fishshell.com/docs/current/license.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreiborisov%2Fdash-fish","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandreiborisov%2Fdash-fish","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreiborisov%2Fdash-fish/lists"}