Convergence JavaScript Developers Guide

This repository contains the Convergence JavaScript Developers Guide that is hosted at https://guide.convergence.io/. It was developed using Material for MkDocs.

Contributing

If you find errors or see room for improvement please create an issue here. Pull requests are always welcome.

Tools and Frameworks

To develop and build this repository the following tools are needed:

• mkdocs-material >= 7.1.x
• Docker => 0.20.x

The developers primary work on MacOS / Linux so most scripts and instructions assume a Linux / Unix like build environment.

Development

The developers prefer a docker based workflow. First, obtain the docker image for mkdocs-material:

docker pull squidfunk/mkdocs-material

To serve the project live issue the following command from the root of the repository:

docker run \
  --rm \
  -it \
  -p 7000:7000 \
  -v ${PWD}:/docs \
  squidfunk/mkdocs-material serve --dev-addr 0.0.0.0:7000

Then visit: http://localhost:7000/

static Build

To build the static content for the site issue the following command:

docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build

This will create the site directory in the root of the project. This directory is in the .gitignore file so that it won't be accidentally checked in.

Docker

Build

To build the container run the following command:

docker build -t convergencelabs/js-dev-guide .

Run

To run the build container run the following command:

docker run --rm \
  --name convergence-js-dev-guide \
  -p 8888:80 \
  convergencelabs/js-dev-guide

Then browse to http://localhost:8888

Scripts

Several convenience scripts are located in the scripts directory. They require docker and bash.