lxang723/truelicense-docs

This is the source code repository for the documentation website for TrueLicense

TrueLicense Docs

This is the source code repository for the documentation website truelicense.namespace.global.

Git Flow

This repository uses Git Flow. Please make sure to have the Git Flow (AVH Edition) extension installed in Git. Once the extensions are installed, you can initialize your cloned repository for Git Flow using:

git flow init --defaults --tag v

To start a feature branch:

git flow feature start <feature-name>

To finish a feature branch:

git flow feature finish [<feature-name>]

For a general introduction, please read this blog posting.

Prerequisites

• Node.js

It is recommended to use this repository with Linux or macOS. Windows may work, but is generally not supported.

$ npm install

Development

This repository uses VuePress. To start a local development server:

$ npm run docs:dev

Build

To build the static site:

$ npm run docs:build

Deployment

Every commit on the master branch gets automatically deployed to the website using a GitHub action.