silverstripe-platform/elder2fs

There is no license information available for the latest version (dev-master) of this package.

Elder to filesystem converter

Maintainers

Details

github.com/silverstripeltd/elder2fs

Source

Issues

Installs: 311

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 11

Forks: 0

Open Issues: 0

dev-master 2018-07-24 21:16 UTC

Requires

Requires (Dev)

Unknown License 7875aa2caeadadbb59840cd4ba65c6d371ff1ff0

This package is not auto-updated.

Last update: 2024-12-22 03:50:25 UTC

README

This tool connects to Elder and renders KB articles into regular md files.

Installation

composer require "silverstripeltd/elder2fs"

Usage

In your project root, create elder2fs.yml. Here is an example:

elderUrl: <elder URL>
variables:
  platform:
    companyName: Terrible Ideas Ltd.
pages:
  stuff:
    index.md:
      url: https://github.com/silverstripe/silverstripe-framework/blob/4/docs/en/index.md
    installation.md:
      url: https://github.com/silverstripe/silverstripe-framework/tree/4/docs/en/00_Getting_Started/01_Installation/index.md

elderUrl is the address at which Elder is running. It's specific to your infrastructure.

variables must contain all variables required by the KBs being rendered, otherwise Elder API calls will fail.

pages is the output tree of directories and Markdown files. Missing directories will be created.

Once configured, you can run elder2fs by:

vendor/bin/elder2fs

If it's human operated, you might want to ensure caches are flushed, especially if you have just committed some changes:

vendor/bin/elder2fs --flush