Invoice Ninja Documentation

Note: This is the documentation for version 5 of the Invoice Ninja.

Documentation is available at https://invoiceninja.github.io.

Table of contents

• Invoice Ninja Documentation
  • Table of contents
  • Introduction
  • Getting started
    • Clone the repository
    • Change directory and install dependencies
    • Preview it
  • Code of Conduct
  • Licence

Introduction

Invoice Ninja documentation is written in the markdown. To process and compile docs locally, we'll need PHP & Node.js.

The documentation is using Laravel Jigsaw (https://jigsaw.tighten.co/) as a processing engine.

Getting started

Clone the repository

git clone https://github.com/invoiceninja/invoiceninja.github.io.git

Change directory and install dependencies

cd invoiceninja.github.io
composer i
npm i

Preview it

npm run watch
vendor/bin/jigsaw serve

Now you should be able to edit & preview your changes in real-time.

The official repository is configured to build the site on each commit, so there's no need to compile the production version locally.

Code of Conduct

Code of conduct can be found in our main repository. Code of Conduct.

Licence

Licence can be found in our main repository. Licence.