PHPackages                             wpjscc/wn-docs-plugin - 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. wpjscc/wn-docs-plugin

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

wpjscc/wn-docs-plugin
=====================

Read and manage documentation within Winter CMS

039PHP

Since Feb 21Pushed 2y agoCompare

[ Source](https://github.com/wpjscc/wn-docs-plugin)[ Packagist](https://packagist.org/packages/wpjscc/wn-docs-plugin)[ RSS](/packages/wpjscc-wn-docs-plugin/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (3)Used By (0)

Docs Plugin
===========

[](#docs-plugin)

[![GitHub Workflow Status (branch)](https://camo.githubusercontent.com/3819d14871930c163d0547ca966431677f1e8bd71967bd438e5de6572f240792/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f77696e746572636d732f776e2d646f63732d706c7567696e2f54657374732f6d61696e3f6c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/wintercms/wn-docs-plugin/actions)[![Codecov](https://camo.githubusercontent.com/a60194b58a41b440c8ff92a1aa1b97e35f59a59c93f5b564be728daabb605cd4/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f77696e746572636d732f776e2d646f63732d706c7567696e3f7374796c653d666c61742d737175617265)](https://codecov.io/gh/wintercms/wn-docs-plugin)[![Discord](https://camo.githubusercontent.com/9ccde68755bc7666e40d293b454327a4315cb3ed8e7839dfaee5d6dc46fc5d01/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f3831363835323531333638343139333238313f6c6162656c3d646973636f7264267374796c653d666c61742d737175617265)](https://discord.gg/D5MFSPH6Ux)

Integrates a full suite of documentation direct into your Winter CMS installation. Documentation can be generated from Markdown files or analysed from PHP code.

Features
--------

[](#features)

- Generate documentation locally from your plugin, or from a remote ZIP file.
- Create content-based documentation from Markdown files.
- Create API documentation from PHP doc-blocks and parsed PHP code.
- Can be used in both the Backend and CMS.

Getting started
---------------

[](#getting-started)

To install the plugin, you may install it through the [Winter CMS Marketplace](https://github.com/wintercms/wn-docs-plugin), or you may install it using Composer:

```
composer require winter/wn-docs-plugin
```

Then, run the migrations to ensure the plugin is enabled:

```
php artisan winter:up
```

Registering documentation
-------------------------

[](#registering-documentation)

Documentation can be registered by adding a `registerDocumentation` method to your Plugin class (`Plugin.php`), and will depend on whether the documentation is content-based or API-based, and whether the documentation or code is stored locally or remotely.

```