silverstripe/docstation

A module for viewing user docs in the CMS

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 1

Forks: 0

Open Issues: 1

Type:silverstripe-vendormodule

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

This package is auto-updated.

Last update: 2022-01-23 11:10:48 UTC


README

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

screenshot.png

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