{"id":13668914,"url":"https://github.com/selfboot/html2Dash","last_synced_at":"2025-04-27T01:31:58.067Z","repository":{"id":21178003,"uuid":"24482602","full_name":"selfboot/html2Dash","owner":"selfboot","description":"Generate a docset from any HTML documentations. Written in python","archived":false,"fork":false,"pushed_at":"2023-11-06T11:02:47.000Z","size":421,"stargazers_count":209,"open_issues_count":0,"forks_count":88,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-07T12:07:19.359Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/selfboot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2014-09-26T02:09:43.000Z","updated_at":"2024-12-11T13:14:12.000Z","dependencies_parsed_at":"2023-11-06T12:24:58.705Z","dependency_job_id":"35e2d0e9-578a-41f2-b9df-e42d9ecc3531","html_url":"https://github.com/selfboot/html2Dash","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selfboot%2Fhtml2Dash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selfboot%2Fhtml2Dash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selfboot%2Fhtml2Dash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selfboot%2Fhtml2Dash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/selfboot","download_url":"https://codeload.github.com/selfboot/html2Dash/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251077102,"owners_count":21532607,"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-08-02T08:00:53.810Z","updated_at":"2025-04-27T01:31:53.038Z","avatar_url":"https://github.com/selfboot.png","language":"Python","readme":"# html2Dash\n\nhtml2Dash is an Documentation Set generator intended to be used with the [Dash.app](http://kapeli.com/dash/) API browser for OS X or one of its many clones. html2Dash is just like [doc2dash](https://github.com/hynek/doc2dash) but generating docset from any HTML documentations.\n\nIf you’ve never heard of Dash.app, you’re missing out: together with html2Dash it’s all your API documentation at your fingertips!\n\nThird part library required:\n   \n    beautifulsoup4==4.3.2\n\nIt’s tested on Python 2.7, OS X 10.9.\n\n# How to Use\n\nThe usage is as simple as:\n\n\t$ html2Dash \u003chtmldir\u003e\n\nhtml2dash will create a new directory called `\u003chtmldir\u003e.docset` in `~/Library/Application Support/html2dash/DocSets` containing a Dash.app-compatible docset. When finished, the docset is automatically added to Dash.app.\n\n**Options and Arguments**\n\nThe full usage is:\n\n\t$ doc2dash [OPTIONS] SOURCE  \n\nThe `SOURCE` is a directory containing the HTML documents you would like to convert.\n\nValid `OPTIONS` are the following:\n\n* -n, --name  \n\n\tName the docset explicitly instead of letting doc2dash guess the correct name from the directory name of the source.\n\n* -d PATH, --destination PATH  \n\n\tPut the resulting docset into PATH. Default is the directory `~/Library/Application Support/html2dash/DocSets` \n\n* -i FILENAME, --icon FILENAME\n\n\tAdd PNG icon FILENAME to docset that is used within Dash.app to represent the docset.\n\t\n* -p INDEX_PAGE, --index-page INDEX_PAGE\n\t\n\tSet the file that is shown when the docset is clicked within Dash.app.\n\t\n* -h, --help\n\n\tShow a brief usage summary and exit.\n\nDEPENDENCIES:  \n\t\n* BeautifulSoup HTML parsing library\n\n# Demo\n\nGenerate the Docset for requests: `requests.docset`. Command：\n\n    $ ./html2dash.py -n requests -i ~/Documents/requests-sidebar.png ~/Documents/requests  \n    Create the Docset Folder!  \n    Copy the HTML Documentation!  \n    Create the SQLite Index    \n    Create the Info.plist File  \n    Create the Icon for the Docset!  \n    Generate Docset Successfully!  \n\n\n","funding_links":[],"categories":["HTML"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fselfboot%2Fhtml2Dash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fselfboot%2Fhtml2Dash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fselfboot%2Fhtml2Dash/lists"}