2017 © Pedro Peláez
 

library elder2fs

Elder to filesystem converter

image

silverstripe-platform/elder2fs

Elder to filesystem converter

  • Tuesday, July 24, 2018
  • by mateusz
  • Repository
  • 6 Watchers
  • 0 Stars
  • 51 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 3 Versions
  • 16 % Grown

The README.md

Elder2fs

This tool connects to Elder and renders KB articles into regular md files., (*1)

Installation

composer require "silverstripeltd/elder2fs"

Usage

In your project root, create elder2fs.yml. Here is an example:, (*2)

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., (*3)

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

pages is the output tree of directories and Markdown files. Missing directories will be created., (*5)

Once configured, you can run elder2fs by:, (*6)

vendor/bin/elder2fs

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

vendor/bin/elder2fs --flush

The Versions

24/07 2018

dev-master

9999999-dev

Elder to filesystem converter

  Sources   Download

The Requires

 

The Development Requires

24/07 2018

dev-flush

dev-flush

Elder to filesystem converter

  Sources   Download

The Requires

 

The Development Requires

20/03 2017

dev-accept

dev-accept

Elder to filesystem converter

  Sources   Download

The Requires