dfak-cli

Digital First Aid Kit Content as Code CLI tool

Command line tool to manage content workflows for the Apprentice project. It uses the content as code framework.

• Features
• Install
• Usage
• Links

Features

This tool currently enables users to:

• Deploy and navigate a local version of the DFAK content.
• Customise DFAK content locally and preview changes.
• Contribute back your changes

Install

Prerequisites

• Install nvm

  • touch ~/.bash_profile
  • curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash
  • Open a new Terminal window and check if nvm is installed correctly:
    • command -v nvm
    • This should display nvm if not please check the nvm documentation https://github.com/creationix/nvm#install-script

• Install node v8.11.4 with nvm

  • nvm install v8.11.4
  • nvm alias default v8.11.4
  • Check your version of node with: node --version

• Install npm v6.4.1

  • npm i -g npm
  • Check your npm version : npm --version

• Install docsmith v0.8.2:

  • npm i -g docsmith@beta

• Install pandoc 1.19

  • OSX
    • Install brew following this instructions https://brew.sh/
    • brew install pandoc
  • Linux
    • apt-get install pandoc

DFAK Command Line Interface Tool (CLI)

You can now install the CLI with:

npm i -g dfak-cli

Initialise workspace

mkdir workspace
cd workspace
dfak init
# Type enter to accept the proposed default 
# Type yes to confirm 

Usage

dfak start

This will start the preview server and watch your local files for changes. You can open your browser at http://localhost:8081 to browse the preview.

Working on a fork

Currently, in order to work on a fork, the following manual steps need to be followed:

cd ~/.content/packages
rm -rf dfak
git clone YOURFORK_URL/dfak.git
cd dfak
npm i

After this, running dfak start in your workspace should now build your fork.

Editor

The recommended text editor is Atom https://atom.io together with the following packages:

• markdown-preview-enhanced
• linter
• linter-ui-default
• linter-remark

Links

• Related repositories
  • dfak content package https://github.com/iilab/DFAK
  • Content as code https://github.com/iilab/contentascode
  • CLI Framework https://github.com/docsmith/docsmith