Skip to content

wp-cli/dash-docset-generator

Folders and files

Image for: Folders and files
NameName
Last commit message
Last commit date

Latest commit

Image for: Latest commit
 

History

Image for: History
34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Image for: Repository files navigation

WP-CLI Dash Docset Generator

This project generates Dash docsets for all versions of the WP-CLI commands documentation.

Supported Dash features

Image for: Supported Dash features

Usage

Image for: Usage

Prerequisites

You’ll need the following software to generate the docsets:

Docset generation

Run make to generate the docsets:

$ git clone git@github.com: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