{"id":20618278,"url":"https://github.com/tddschn/powershell-docset","last_synced_at":"2025-08-13T22:08:54.277Z","repository":{"id":49312455,"uuid":"517019204","full_name":"tddschn/powershell-docset","owner":"tddschn","description":null,"archived":false,"fork":false,"pushed_at":"2023-02-08T04:38:03.000Z","size":413,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-17T04:47:53.867Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/tddschn.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":"2022-07-23T09:53:23.000Z","updated_at":"2024-12-08T13:38:31.000Z","dependencies_parsed_at":"2023-02-09T14:16:29.748Z","dependency_job_id":null,"html_url":"https://github.com/tddschn/powershell-docset","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tddschn%2Fpowershell-docset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tddschn%2Fpowershell-docset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tddschn%2Fpowershell-docset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tddschn%2Fpowershell-docset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tddschn","download_url":"https://codeload.github.com/tddschn/powershell-docset/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242277652,"owners_count":20101536,"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":[],"created_at":"2024-11-16T12:07:47.709Z","updated_at":"2025-03-06T19:43:30.044Z","avatar_url":"https://github.com/tddschn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# powershell-docset : A dash docset for powershell modules\r\n\r\nBased on [lucasg](https://github.com/lucasg)'s [powershell-docset](https://github.com/lucasg/powershell-docset).\r\n\r\nMajor Changes:\r\n- Added support for running on GitHub actions and local dependency installation via `poetry`.\r\n- Updated the default Powershell documentation version to 7.2.\r\n\r\n### Status\r\n\r\n[![Scrape Powershell doc and build docset](https://github.com/tddschn/powershell-docset/actions/workflows/scrape-and-build.yaml/badge.svg)](https://github.com/tddschn/powershell-docset/actions/workflows/scrape-and-build.yaml)\r\n\u003c!-- [![Build Status](https://travis-ci.org/lucasg/powershell-docset.svg?branch=master)](https://travis-ci.org/lucasg/powershell-docset) --\u003e\r\n\r\n`posh-to-dash.py` scrapes the newly announced `https://docs.microsoft.com/en-us/powershell/module/` website in order to create an offline dash-compatible archive to be viewed in `Dash`, `Zeal` or `Velocity` :\r\n\r\n\u003cp align=\"center\"\u003e\r\n\u003cimg alt=\"Powershell docset in Velocity\" src=\"screenshots/posh-docset.PNG\"/\u003e\r\n\u003c/p\u003e\r\n\r\n## Releases\r\n\r\n\u003c!-- - [v0.1 -- Minimal working version](https://github.com/lucasg/powershell-docset/releases/tag/v0.1)\r\n- [v0.2 -- Offline mode supported](https://github.com/lucasg/powershell-docset/releases/tag/v0.2)\r\n- [v0.3 -- travis setup](https://github.com/lucasg/powershell-docset/releases/tag/v0.3)\r\n- [v0.4 -- user contributed docset](https://github.com/lucasg/powershell-docset/releases/tag/v0.4)\r\n- [v0.5 -- versioned docsets](https://github.com/lucasg/powershell-docset/releases/tag/v0.5)\r\n- [v0.6 -- windows 10 modules documentation](https://github.com/lucasg/powershell-docset/releases/tag/v0.6) --\u003e\r\n\u003c!-- - [v0.7.2 -- powershell 7.1 documentation](https://github.com/lucasg/powershell-docset/releases/tag/v0.7.2) --\u003e\r\n- [v7.2.5 -- powershell 7.2.5 documentation](https://github.com/tddschn/powershell-docset/releases/tag/v7.2.5)\r\n\r\n## Running on GitHub Actions\r\n\r\nThe [Scrape Powershell doc and build docset](https://github.com/tddschn/powershell-docset/actions/workflows/scrape-and-build.yaml) action crawls the powershell 7.2 documentation, builds the docset, and uploads the built artifact.\r\n\r\nModify the doc version in [posh-to-dash.py](./posh-to-dash.py) to scrape another version of the powershell documentation.\r\n## Local Installation \u0026 Execution\r\n\r\n`posh-to-dash.py` relies on :\r\n\r\n- `requests` for http(s) downloads\r\n- `selenium` and `phantomjs` for webscraping\r\n- `bs4` for html parsing and rewriting\r\n\r\n1. Clone the repository\r\n2. Install the dependencies from requirements.txt, use a virtualenv to avoid problems with dependencies and versions. Alternatively if you use `poetry`, run `poetry install`.\r\n3. Download the geckodriver from [Mozilla's Repo](https://github.com/mozilla/geckodriver/releases), download the version that matches your OS.\r\n4. Place the geckodriver in your path\r\n\r\n- If Windows, grab the executable an place it in `%USERPROFILE%\\AppData\\Local\\Microsoft\\WindowsApps`\r\n\r\n- If Linux, move it to your `~/.local/bin` or wherever you have your path\r\n\r\n5. Start scraping by typing : `posh-to-dash.py --output=$outputfile --version=6 --temporary`\r\n\r\n- if `--output` is not provided, `posh-to-dash.py` will output \"Powershell.tgz' into the working directory\r\n- the `--version` switch support only Powershell API versions `5.1`, `7.2` (default) and `7.3` , the rest are obsolete by Microsoft.\r\n- `--temporary` specify to download the web scraping resources in a temporary folder instead of clobbering the current directory. However if the download fail, the results will be thrown out.\r\n\r\n**NOTE: The process takes 15+ minutes to run. The more versions you download increases the time.**\r\n\r\n## Add your docset to Zeal\r\n\r\nWith the Powershell.tar file, unzip it and place it in `C:\\Users\\\u003cyour-username\u003e\\AppData\\Local\\Zeal\\Zeal\\docsets`\r\n\r\n## Limitations\r\n\r\nThe powershell modules API endpoint is quite new, so it may be subject to breakage by the `docs.microsoft.com` people.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftddschn%2Fpowershell-docset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftddschn%2Fpowershell-docset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftddschn%2Fpowershell-docset/lists"}