https://github.com/wordpress/phpdoc-parser
Documentation parser powering developer.wordpress.org
https://github.com/wordpress/phpdoc-parser
Last synced: about 1 year ago
JSON representation
Documentation parser powering developer.wordpress.org
- Host: GitHub
- URL: https://github.com/wordpress/phpdoc-parser
- Owner: WordPress
- Created: 2013-01-30T22:33:49.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2024-11-22T16:15:04.000Z (over 1 year ago)
- Last Synced: 2025-04-14T22:13:52.201Z (about 1 year ago)
- Language: PHP
- Homepage: https://developer.wordpress.org/reference/
- Size: 1.07 MB
- Stars: 240
- Watchers: 27
- Forks: 79
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WP Parser
WP-Parser is the parser for creating the new code reference at [developer.wordpress.org](https://developer.wordpress.org/reference). It parses the inline documentation and produces custom post type entries in WordPress.
We are currently looking for contributors to help us complete the work on the parser.
There is a guide to developing for developer.wordpress.org in the [WordPress documentation handbook](https://make.wordpress.org/docs/handbook/projects/devhub/)
## Requirements
* PHP 5.4+
* [Composer](https://getcomposer.org/)
* [WP CLI](https://wp-cli.org/)
Clone the repository into your WordPress plugins directory:
```bash
git clone https://github.com/WordPress/phpdoc-parser.git
```
After that install the dependencies using composer in the parser directory:
```bash
composer install
```
## Running
Activate the plugin first:
wp plugin activate phpdoc-parser
In your site's directory:
wp parser create /path/to/source/code --user=