Digital First Aid Kit Content as Code CLI tool

Activist Apprentice is...

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 (cf. https://github.com/creationix/nvm#install-script)

  • 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

• 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

  • brew install pandoc
  • 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

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.

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