Chimpsky

A Markdown 2 HTML library by Toru Interactive

Setup

./guides/setup.md

Configuration

The following overrides can be set in the ./chimpsky.config.js in your project.

const paths = {
  "src" : "./src",
  "markdown" : "./docs",
  "menus" : "./docs/menus",
  "public" : "./public",
  "templates" : "./src/templates",
  "dist" : "./dist",
  "edit_base" : "https://gitlab.com/my-group/my-project/blob/master",
  "issues_url" : "https://gitlab.com/my-group/my-project/issues/new"
}

const metadata = {
  "template" : "default",
  "title" : "My Web Page" 
}

Usage

node build; # builds all files in one go
node watch; # watches `docs` and builds pages as they're edited
node watch-reload-templates; # same as watch but reloads templates. For chimpsy dev.

Developing

How to work on a local copy of chimpsky in your project. First clone your project into your Vagrant box...

• make a /app/tmp folder in your vagrant box
• make sure /tmp is .gitignored in your project
• Clone chimpsky into /app/tmp/chimpsky

then npm link your local version of chimpsky to your project root...

vagrant ssh;
cd /app/tmp/chimpsky;
sudo npm link;
cd /app
sudo npm link chimpsky;

Then you can work on the files in your project's /tmp/chimpsky folder and run them directly from your project without publishing.

Publishing

change the version number in ./tmp/chimpsky/package.json & commit your change, then publish...

vagrant ssh;
cd /app/tmp/chimpsky;
npm adduser; # use Sean's NPM login
npm publish --access public;

goto chimpsky's NPM page to see if it's published. You should see your new version number on the right.