Interactive Q&A Guides for Web and the Command Line
Table of Contents
npm install --global self-help
Navigate a Self-Help Document from the Command Line:
self-help interactive --source ./path/to/help-document.js
Generate Markdown from a Self-Help Document:
self-help markdown --source ./path/to/help-document.js
Markdown is written to stdout for you to pipe into other Command Line Programs or write to a file.
self-help RxJS Operator Decision Tree Example exported as Markdown.
👩🏽💻 Writing Documents
getHelpDocument method of type
It returns a Nested Hierarchy of Node Objects.
Which form the Decision Tree a User will navigate.
Branch presents multiple options to choose from in the form of its
children Array. Children can be a combination of other
label: 'I just cloned the project, and'children: ...
AsyncBranch is the same as a
Branch except its
children property is a Function which returns a Promise.
This mechanism allows Help Documents to be combined and linked together, use it to compose higher-level guides which pull together other Help Documents hosted online or break down a large Help Document into smaller files that can be lazily-loaded at runtime.
label: 'I just cloned the project, and'Promise
A Leaf represents the answer the User has been looking for as they have been navigating a given Help Document. The value can be any String, but is normally the contents of a Markdown Document which explains the answer to the User.
label: 'I want to install dependencies'value: fs
🙋🏿♂️ Getting Help
👀 Other Projects
If you find my Open Source projects useful, please share them ❤️
ESLint Formatter featuring Git Author, Date, and Hash
Move and rename files while keeping imports up to date
Convert functions to arrow functions
Automates ImageOptim, ImageAlpha, and JPEGmini for Mac to make batch optimisation of images part of your automated build process.
Write Beautiful Specs with Custom Matchers
Run Benchmark.js over multiple Browsers, with CI compatible output
Manage multiple package.json files, such as in Lerna Monorepos and Yarn Workspaces
I'm Jamie Mason from Leeds in England, I began Web Design and Development in 1999 and have been Contracting and offering Consultancy as Fold Left Ltd since 2012. Who I've worked with includes Sky Sports, Sky Bet, Sky Poker, The Premier League, William Hill, Shell, Betfair, and Football Clubs including Leeds United, Spurs, West Ham, Arsenal, and more.