PHPackages                             winter/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. [API Development](/categories/api)
4. /
5. winter/wn-docs-plugin

ActiveWinter-plugin[API Development](/categories/api)

winter/wn-docs-plugin
=====================

Read and manage documentation within Winter CMS

v1.0.2(1y ago)53.0k↓50%9[2 issues](https://github.com/wintercms/wn-docs-plugin/issues)[1 PRs](https://github.com/wintercms/wn-docs-plugin/pulls)1MITPHPPHP >=7.2.9CI passing

Since Jul 23Pushed 8mo ago4 watchersCompare

[ Source](https://github.com/wintercms/wn-docs-plugin)[ Packagist](https://packagist.org/packages/winter/wn-docs-plugin)[ Docs](https://github.com/wintercms/wn-docs-plugin)[ GitHub Sponsors](https://github.com/wintercms)[ Fund](https://opencollective.com/wintercms)[ RSS](/packages/winter-wn-docs-plugin/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (3)Versions (5)Used By (1)

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

[](#docs-plugin)

[![GitHub Workflow Status (branch)](https://camo.githubusercontent.com/e893f2e745f738de83a820e7b30d2735a17a1ddfb5bccb1f62c0a6688b8cc2bd/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f77696e746572636d732f776e2d646f63732d706c7567696e2f74657374732e79616d6c3f6272616e63683d6d61696e266c6162656c3d5465737473267374796c653d666c61742d737175617265)](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.

```