activist-apprentice v0.0.10

Activist Apprentice 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

A quick walk through...

Install

Prerequisites:

• node v6 minimum, v8.9 LTS recommended

  • MacOS note that installation via brew is not yet supported.

• npm v5.6.0

  • npm i -g npm

• docsmith v0.7.9:

  • npm i -g docsmith@beta

• pandoc 1.19

  • brew install pandoc
  • apt-get install pandoc

Prerequisites for APK build

The following are only required if you wish to use the apprentice build mobile command which will generate an APK for your project.

• exp v54.0.1:

  • npm i -g exp

• docker:

  • https://docs.docker.com/docker-for-mac/install/
  • make sure that you set Docker to minimum 8GB memory (Docker icon > Preferences > Advanced).

Apprentice Command

You can now install the CLI with:

npm i -g activist-apprentice

Usage

mkdir workspace
cd workspace
apprentice init

This will prompt you with a few questions about configuration. The defaults should work in the majority of cases.

apprentice 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

Structure

This template is organised as follow.

The markdown files respect the following guidelines:

• Use frontmatter only in special cases.
• Titles are automatically taken from

Links

• Related repositories
  • activist-apprentice-course-template content package https://github.com/contentascode/activist-apprentice-course-template
  • Content as code https://github.com/iilab/contentascode
  • CLI Framework https://github.com/docsmith/docsmith