PHPackages                             arnaudban/wp-doc-viewer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. arnaudban/wp-doc-viewer

ActiveWordpress-plugin[Utility & Helpers](/categories/utility)

arnaudban/wp-doc-viewer
=======================

Show the user doc in the admin area of your WordPress installation

v1.3.0(5y ago)23.7k[1 PRs](https://github.com/ArnaudBan/wp-doc-viewer/pulls)MITPHPPHP >=7.0

Since Mar 18Pushed 5y ago1 watchersCompare

[ Source](https://github.com/ArnaudBan/wp-doc-viewer)[ Packagist](https://packagist.org/packages/arnaudban/wp-doc-viewer)[ RSS](/packages/arnaudban-wp-doc-viewer/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (8)Dependencies (4)Versions (10)Used By (0)

WP Doc Viewer
=============

[](#wp-doc-viewer)

Le principe est d'afficher l'aide utilisateur d'un theme dans l'admin de WordPress.

Pour ce faire, créer un dossier **doc/** à la racine de votre thème. Dans ce dossier vous pourrez ajouter autant de ficheir d'aide en Markdown que vous le souhaitez. Tout ces fichiers seront alors visible dans un menu "Theme Doc" dans l'admin de Wordpress.

Ajouter d'autre dossier que le plugin va parser avec le filtre suivant :

```
add_filter('mdv/doc-paths', static function( $path){

    $path[] = plugin_dir_path(__FILE__) . 'doc';
    return $path;
} );
```

Meta Markdown
-------------

[](#meta-markdown)

Chaque fichier markdown peut déclarer ( ou non ) les metas suivantes :

```
---
title: 'Icones SVG'
order: 10
section: 'Blocs'
---

```

- `title` : Le titre qui sera afficher dans le menu et la table des matière
- `order` : Permet de gérer l'ordre d'affichage des l'aides au sein de sa section
- `section` : Nom de la section ou l'aide dois s'afficher ( si aucune section n’est déclaré le fichier d’aide s’affiche dans la section générale )

Section
-------

[](#section)

Toutes les fichiers d’aides sont organisé en section. Pour gérer la section utiliser soit les metas soit arganiser votre dossier "doc" avec des sous-dossier. Votre hierachie de dossier sera transposer en section.

Aide contextuelles
------------------

[](#aide-contextuelles)

Cce plugin peux également ajouter votre aide dans l'aide contextuelle des différentes page de l'admin. Cela ce fait par convention de nomage des fichiers Markdown Pour le moment sont pris en compte :

- archive-{post-type}.md : affiche votre aide dans la liste du post type
- single-{post-type}.md : affiche votre aide dans sur la page de modification d'un post du post type ( ne marche plus avec le nouvelle éditeur en bloc )
- {modele-de-page}.md : affiche votre aide dans sur la page de modification d'une page utilisant le modéle de page avec le même nom ( modele-de-page.php )

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 62.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~76 days

Recently: every ~45 days

Total

8

Last Release

2073d ago

PHP version history (2 changes)v1.2.3PHP >=7.3.0

V1.2.4PHP >=7.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/c0b585fa68920111e6ed2e55aa76c470255a2cccf408223c0834d83982934bf4?d=identicon)[ArnaudBan](/maintainers/ArnaudBan)

---

Top Contributors

[![ArnaudBan](https://avatars.githubusercontent.com/u/1626370?v=4)](https://github.com/ArnaudBan "ArnaudBan (5 commits)")[![marc-gade](https://avatars.githubusercontent.com/u/15939896?v=4)](https://github.com/marc-gade "marc-gade (2 commits)")[![chles](https://avatars.githubusercontent.com/u/7695129?v=4)](https://github.com/chles "chles (1 commits)")

---

Tags

wordpresswordpress-plugin

### Embed Badge

![Health badge](/badges/arnaudban-wp-doc-viewer/health.svg)

```
[![Health](https://phpackages.com/badges/arnaudban-wp-doc-viewer/health.svg)](https://phpackages.com/packages/arnaudban-wp-doc-viewer)
```

###  Alternatives

[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

728272.9k17](/packages/civicrm-civicrm-core)[afragen/git-updater

A plugin to automatically update GitHub, Bitbucket, GitLab, or Gitea hosted plugins, themes, and language packs.

3.3k1.6k](/packages/afragen-git-updater)[verbb/formie

The most user-friendly forms plugin for Craft.

101372.9k40](/packages/verbb-formie)[solspace/craft-freeform

The most flexible and user-friendly form building plugin!

52664.9k12](/packages/solspace-craft-freeform)[wp-hooks/generator

Generates a JSON representation of the WordPress actions and filters in your code

86178.4k3](/packages/wp-hooks-generator)[horstoeko/zugferdvisualizer

A library

33198.3k2](/packages/horstoeko-zugferdvisualizer)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)