WordPress / WordPress/phpdoc-parser

Standalone / static .html output

Open
#151 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
PHP
Stars
239
Forks
81
Avg merge
16h 29m
Merged PRs (30d)
8

Description

Tangentially related to #14.

I'd like to have the option of generating a bunch of static .html files (like phpDocumentor or ApiGen would do) from the .json output. This could then be used to create a docset for Dash (one exists for WP core, but I'm thinking of doing it for a theme) or some other standalone / offline documentation system that doesn't allow a full install of WP.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining how the existing .json output is generated and review the related context in issue #14. Done means the parser can also generate a set of standalone static .html files suitable for offline documentation or a Dash docset.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.