https://github.com/invoiceninja/invoiceninja.github.io
Documentation for Invoice Ninja
https://github.com/invoiceninja/invoiceninja.github.io
hacktoberfest
Last synced: 4 months ago
JSON representation
Documentation for Invoice Ninja
- Host: GitHub
- URL: https://github.com/invoiceninja/invoiceninja.github.io
- Owner: invoiceninja
- Created: 2020-04-02T21:15:42.000Z (about 5 years ago)
- Default Branch: v5-rework
- Last Pushed: 2025-02-13T20:50:07.000Z (4 months ago)
- Last Synced: 2025-02-14T23:30:19.805Z (4 months ago)
- Topics: hacktoberfest
- Language: Blade
- Homepage: https://invoiceninja.github.io
- Size: 57.2 MB
- Stars: 13
- Watchers: 6
- Forks: 36
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Invoice Ninja Documentation
**Note:** This is the documentation for version 5 of the Invoice Ninja.
Documentation is available at [https://invoiceninja.github.io](https://invoiceninja.github.io).
### Table of contents
- [Invoice Ninja Documentation](#invoice-ninja-documentation)
- [Table of contents](#table-of-contents)
- [Introduction](#introduction)
- [Getting started](#getting-started)
- [Clone the repository](#clone-the-repository)
- [Change directory and install dependencies](#change-directory-and-install-dependencies)
- [Preview it](#preview-it)
- [Code of Conduct](#code-of-conduct)
- [Licence](#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
```bash
git clone https://github.com/invoiceninja/invoiceninja.github.io.git
```
#### Change directory and install dependencies
```bash
cd invoiceninja.github.io
composer i
npm i
```
#### Preview it
```bash
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](https://github.com/invoiceninja/invoiceninja/blob/master/CODE_OF_CONDUCT.md).
### Licence
Licence can be found in our main repository. [Licence](https://github.com/invoiceninja/invoiceninja/blob/master/LICENSE).