https://github.com/wp-cli/dash-docset-generator
WP-CLI Dash docset generator
https://github.com/wp-cli/dash-docset-generator
dash docset hacktoberfest wp-cli
Last synced: 15 days ago
JSON representation
WP-CLI Dash docset generator
- Host: GitHub
- URL: https://github.com/wp-cli/dash-docset-generator
- Owner: wp-cli
- License: mit
- Created: 2017-12-24T04:49:40.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-04-27T15:25:29.000Z (about 2 years ago)
- Last Synced: 2025-06-08T23:51:37.830Z (18 days ago)
- Topics: dash, docset, hacktoberfest, wp-cli
- Language: PHP
- Homepage:
- Size: 86.9 KB
- Stars: 16
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# WP-CLI Dash Docset Generator
This project generates [Dash](https://kapeli.com/dash) [docsets](https://kapeli.com/docsets) for [all versions](https://github.com/wp-cli/handbook/releases) of the WP-CLI commands documentation.
## Supported Dash features
- ✅ [Table of contents](https://kapeli.com/docsets#tableofcontents)
- ✅ [Index page](https://kapeli.com/docsets#settingindexpage)
- ✅ [Online redirection](https://kapeli.com/docsets#onlineRedirection)
## Usage
### Prerequisites
You’ll need the following software to generate the docsets:
- PHP \>=7.0
- [Composer](https://getcomposer.org/)
- [Make](https://www.gnu.org/software/make/)
### Docset generation
Run `make` to generate the docsets:
```
$ git clone [email protected]:wp-cli/dash-docset-generator.git
$ cd dash-docset-generator
$ make
```
This will generate the following files:
```
.
├─ versions ← Versioned docsets
│ ├─ X.X.X ← e.g. 1.2.0
│ │ ├─ WP-CLI.docset ← Docset
│ │ └─ WP-CLI.tgz ← Compressed docset
│ └─ ...
├─ WP-CLI.docset ← Docset for latest version
└─ WP-CLI.tgz ← Compressed docset for latest version
```
### Submitting generated docsets
[Instructions for submitting user-contributed docsets to Dash](https://github.com/Kapeli/Dash-User-Contributions#contribute-a-new-docset)