Skip to content

README.md

Latest commit

 

History

History
46 lines (30 loc) · 782 Bytes

README.md

File metadata and controls

46 lines (30 loc) · 782 Bytes
Raw

InvoiceShelf Documentation

Official documentation for InvoiceShelf built with VitePress.

Development

# Install dependencies
yarn install

# Start development server
yarn dev

# Build documentation
yarn build

# Preview production build
yarn serve

Docker

Using Docker Compose

Run the documentation site locally:

docker-compose up -d

The site will be available at http://localhost:8001

Building Docker Image

docker build -t invoiceshelf/docs .

Deployment

Every push builds and publishes a commit-SHA image. Pushes to master also publish the latest image.

Images are available at:

  • ghcr.io/invoiceshelf/docs:latest - Latest master build
  • ghcr.io/invoiceshelf/docs:<commit-sha> - A specific commit build