https://github.com/alensiljak/cashier-book

Cashier documentation
https://github.com/alensiljak/cashier-book

Last synced: about 2 months ago
JSON representation

Cashier documentation

• Host: GitHub
• URL: https://github.com/alensiljak/cashier-book
• Owner: alensiljak
• License: agpl-3.0
• Created: 2023-11-21T10:28:34.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-24T16:39:52.000Z (about 2 months ago)
• Last Synced: 2024-11-24T17:27:23.448Z (about 2 months ago)
• Size: 23.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cashier-book

Cashier documentation

https://alensiljak.github.io/cashier-book/

[![Deploy mdBook site to Pages](https://github.com/alensiljak/cashier-book/actions/workflows/mdbook.yml/badge.svg)](https://github.com/alensiljak/cashier-book/actions/workflows/mdbook.yml)

# Introduction

This is the source repository for the Cashier documentation book. It describes the features / requirements for the Cashier app.

# Development

Install `mdbook` with ``.

Preview the book by running `mdbook serve` in the root directory.

Open http://localhost:3000 to view the content.

# Basic mdBook Operations

```sh

mdbook init

mdbook serve --open

```

# Publishing 

There is a GitHub action specific for mdBook publishing, which builds the site and publishes to GitHub Pages.