silverstripe/docstation

A module for viewing user docs in the CMS

dev-main 2021-11-23 10:53 UTC

Requires

• php: ^7.4 || ^8.0
• league/commonmark: ^2.0.2
• silverstripe/admin: ^1.6
• silverstripe/framework: ^4.10
• silverstripe/graphql: ^4
• silverstripe/vendor-plugin: ^1
• silverstripe/versioned: ^1.6

Requires (Dev)

• phpunit/phpunit: ^9.5
• silverstripe/cms: ^4.6
• squizlabs/php_codesniffer: ^3

BSD-3-Clause

• SilverStripe
• The SilverStripe Community

• admin
• silverstripe
• versioned

README

Provides a CMS UI for browsing markdown documentation colocated with the project.

Installation

composer require silverstripe/docstation

Requirements

• silverstripe/graphql:4.x-dev
• PHP >= 7.4

Example:

app/
  docs/
    Adding-a-Product.md
    Cancelling-an-Order.md

app/docs/Adding-a-Product.md

---
title: How do add a product
sort: 1
---

## Been wondering how to add a product?

This guide will give you a
* Step
* by
* step

Tutorial!

Customising the documentation directory

Defaults to app/docs.

SilverStripe\Docstation\Docstation:
  docs_dir: 'app/mydocs'

It also supports module resolution syntax.

SilverStripe\Docstation\Docstation:
  docs_dir: 'somevendor/somemodule: docs'

To do:

• Nested documentation, hierarchical navigation (not sure this is a great idea)
• Make it look not terrible