Experimental userdocs thing

Related tags

Web Applications silverstripe-docstation
Overview

Silverstripe Docstation module

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
You might also like...
(Experimental) Neos / Flow via Roadrunner

Roadrunner distribution This is an experimental distribution to run Neos / Flow via Roadrunner. Note: The Neos / Flow code currently needs patches to

Flowpack 1 May 4, 2022
Comments
  • Use file/folder name for title/heading

    Use file/folder name for title/heading

    E.g. app/docs/1.About.md would define the sort order (first) and the title (About)

    app/docs/2.FAQ/1.Question-1 would be the first sub-item under FAQ, with title "Question 1"

    Et cetera. Pretty much how my Solr docs are generated with a menu structure etc. (https://firesphere.github.io/solr-docs/) from the folder/name structure.

    p.s. Nice work on this one. I'm seeing value in it; quickly editing md, deploying, and simply pointing clients to the docs, updated with the answers to their latest questions

    opened by Firesphere 2
Owner
Aaron Carlino
Principal Product Developer, Silverstripe Ltd. Core team.
Aaron Carlino
GitHub
Feel free to create new file, don't hesitate to pull your code, the most important thing is that the file name here must match your nickname so that file does not conflict with other people.

PHP-Projects hacktoberfest Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to cha

Firmansyah Helmi Kurniawan 43 Nov 28, 2022
CommandHelper - is a very useful thing for quick code testing and more!

CommandHelper CommandHelper - is a very useful thing for quick code testing and more! Examples: Code: require_once('commandhelper.php');

RuvSleep 1 Feb 11, 2022
Experimental library for forking PHP

Spork: PHP on a Fork <?php $manager = new Spork\ProcessManager(); $manager->fork(function() { // do something in another process! return 'Hel

Kris Wallsmith 588 Nov 20, 2022
An experimental object oriented SSH api in PHP

PHP SSH (master) Provides an object-oriented wrapper for the php ssh2 extension. Requirements You need PHP version 5.3+ with the SSH2 extension. Insta

Antoine Hérault 355 Dec 6, 2022
EXPERIMENTAL plugin extending WPGraphQL to support querying (Gutenberg) Blocks as data, using Server Side Block registries to map Blocks to the GraphQL Schema.

WPGraphQL Block Editor This is an experimental plugin to work toward compatiblity between the WordPress Gutenberg Block Editor and WPGraphQL, based on

WPGraphQL 29 Nov 18, 2022
Antware NinjaCrypter is an experimental username and password cookie string class for PHP

Antware NinjaCrypter is an experimental username and password cookie string class for PHP. For study case this crypter is based on password crypting ideology but can also encrypt username and password for storing cookie string that way your login details will not be exposed by hackers that search through cookie string.

Chukwu Remijius 1 Nov 25, 2021
PHP 8.1 like legacy enum (Experimental Alpha Version)

flux-legacy-enum PHP 8.1 like legacy enum Experimental Alpha Version Installation COPY --from=docker-registry.fluxpublisher.ch/flux-enum/legacy:latest

fluxlabs 1 Dec 12, 2022
A collection of experimental block-based WordPress themes.

Frost An experimental block theme for designers, developers, and creators. About Frost is a Full Site Editing theme for WordPress that extends the inc

Fahim Murshed 0 Dec 25, 2021
AWS DynamoDB session handler for Magento (experimental!)

Magento Session Handler for AWS DynamoDB Author: Fabrizio Branca TODO: disable automatic gc create cron that does gc how does it keep track of lifetim

AOE 5 Apr 6, 2017
Experimental ActiveRecord layer on top of Doctrine2 using the Twig templating engine

This is an experiment for building ActiveRecord functionality on top of Doctrine2 using the Twig templating engine. Whether it is called Propel2 or not is irrelevant.

Francois Zaninotto 85 Dec 5, 2022