{"id":24555995,"url":"https://github.com/var7600/website2docset","last_synced_at":"2025-10-09T10:14:45.228Z","repository":{"id":273624579,"uuid":"920335500","full_name":"Var7600/website2docset","owner":"Var7600","description":"Convert HTML documentation to Dash/Zeal docsets easily. This tool helps you transform your HTML documentation into a format compatible with documentation browsers like Dash and Zeal.","archived":false,"fork":false,"pushed_at":"2025-01-22T01:29:39.000Z","size":13,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-09T10:14:44.328Z","etag":null,"topics":["dash","docset","html-css-javascript","python","python3","website","zeal"],"latest_commit_sha":null,"homepage":"","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/Var7600.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":"2025-01-22T01:02:33.000Z","updated_at":"2025-01-22T01:29:42.000Z","dependencies_parsed_at":"2025-01-22T06:16:40.251Z","dependency_job_id":null,"html_url":"https://github.com/Var7600/website2docset","commit_stats":null,"previous_names":["var7600/website2docset"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Var7600/website2docset","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Var7600%2Fwebsite2docset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Var7600%2Fwebsite2docset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Var7600%2Fwebsite2docset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Var7600%2Fwebsite2docset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Var7600","download_url":"https://codeload.github.com/Var7600/website2docset/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Var7600%2Fwebsite2docset/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001325,"owners_count":26083040,"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-10-09T02:00:07.460Z","response_time":59,"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":["dash","docset","html-css-javascript","python","python3","website","zeal"],"created_at":"2025-01-23T04:36:19.930Z","updated_at":"2025-10-09T10:14:45.224Z","avatar_url":"https://github.com/Var7600.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Website2Docset\n[![pytest python](https://github.com/Var7600/website2docset/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/Var7600/website2docset/actions/workflows/python-app.yml)\n\nConvert HTML documentation to Dash/Zeal docsets easily. This tool helps you transform your HTML documentation into a format compatible with documentation browsers like Dash and Zeal.\n\n## Features\n\n- Convert HTML documentation to Dash/Zeal compatible docsets\n- Automatic index generation for quick searching\n- Support for custom icons\n- Configurable metadata\n- Support for different entry types (Function, Class, Section, etc.)\n\n## Installation\n\n### Prerequisites\n\n- Python 3.7 or higher\n- pip package manager\n\n## Installing\n\n```bash\ngit clone https://github.com/Var7600/website2docset.git\ncd website2docset\npip install -e .\n```\n\n## Usage\n\n### Basic Usage\n\nConvert a documentation directory to a docset:\n\n```bash\nwebsite2docset.py  -n MyDocs -v 1.0 path/to/docs\n```\n\n### Command Line Options\n\n```bash\n options:\n  -n, --name          Name of the docset\n  -v, --version       Version of the docset (default: 0.0)\n  -i, --icon          Path to PNG icon (16x16 pixels)\n  -d, --destination   Output directory\n```\n\n### Examples\n\n1. **Create a basic docset:**\n   \n   ```bash\n   website2docset.py -n Python3 -v 1.0 ./python-docs\n   ```\n\n2. **Include a custom icon:**\n   \n   ```bash\n   website2docset.py -n Python3 -v 1.0 -i icon.png ./python-docs\n   ```\n\n3. **Specify output directory:**\n   \n   ```bash\n   website2docset.py -n Python -v 1.0 -d ~/Docsets ./python-docs\n   ```\n\n## Documentation Structure\n\nYour HTML documentation should follow this structure:\n\n```\ndocumentation/\n├── index.html\n├── page1.html\n├── page2.html\n└── assets/\n    ├── css/\n    └── js/\n```\n\nThe `index.html`**file should contain links/href references to all documentation pages with appropriate class attributes for indexing.**\n\n## Configuration\n\n### Entry Types\n\nThe following entry types are supported in your HTML:\n\n- Function\n\n- Class\n\n- Section\n\n- Guide\n\n- Library\n\n- Type\n\n- Variable\n\n- Macro\n  \n  for more about supported entry types see https://kapeli.com/docsets#supportedentrytypes\n\nAdd them as class attributes to your links(**entry types  should be first in your class attributes**):\n\n```html\n\u003ca href=\"function.html\" class=\"Function\"\u003eMy Function\u003c/a\u003e\n```\n\n## Development\n\n### Setting up development environment\n\n```bash\n# Clone the repository\ngit clone https://github.com/Var7600/website2docset.git\ncd website2docset\n\n# Create virtual environment\npython -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\n\n# Install development dependencies\npip install -r requirements.txt\n```\n\n### Running Tests\n\n```bash\npython -m pytest tests/\n```\n\n### Code Style\n\nThis project follows PEP 8 guidelines. To check your code:\n\n```bash\nflake8 website2docset.py\n```\n\nstatic analyzer mypy. To check your code:\n\n```bash\nmypy website2docset.py\n```\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/Develop`)\n3. Commit your changes (`git commit -m 'Add some feature'`)\n4. Push to the branch (`git push origin feature/Develop`)\n5. Open a Pull Request\n\n### Guidelines for contributing:\n\n- Write tests for new features\n- Update documentation as needed\n- Follow the existing code style\n- Write meaningful commit messages\n\n## License\n\n MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [GitHub - zealdocs/zeal: Offline documentation browser inspired by Dash](https://github.com/zealdocs/zeal/)\n\n- [Dash Documentation](https://kapeli.com/docsets#dashDocset)\n\n## Support\n\n**If you find any bugs or have feature requests, please create an issue on GitHub.**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvar7600%2Fwebsite2docset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvar7600%2Fwebsite2docset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvar7600%2Fwebsite2docset/lists"}