An open API service indexing awesome lists of open source software.

https://github.com/swarmauri/docs-peagen-com

ZDX and MkDocs Material documentation website for docs.peagen.com.
https://github.com/swarmauri/docs-peagen-com

docker documentation github-actions mkdocs mkdocs-material namecheap nginx-proxy-manager npmctl peagen static-site zdx

Last synced: 8 days ago
JSON representation

ZDX and MkDocs Material documentation website for docs.peagen.com.

Awesome Lists containing this project

README

          

# docs.peagen.com

Standalone ZDX documentation repository for [docs.peagen.com](https://docs.peagen.com).

## Commands

- `npm ci`
- `npm run check`
- `npm run build`
- `npm run docker:build`
- `npm run dns:plan` (uses PyPI `npmctl>=0.3.10` plus `npmctl-namecheap>=0.3.10`)
- `npm run proxy:plan` (uses PyPI `npmctl`)

The GitHub workflows install `npmctl>=0.3.10` and `npmctl-namecheap>=0.3.10` from PyPI, then use `npmctl validate`, `npmctl plan`, and `npmctl apply` against `desired-state/`.

## Deployment

This repo deploys as the `docs-peagen-com` self-hosted Docker service. DNS is managed through the PyPI `npmctl-namecheap>=0.3.10` provider for the `peagen.com` zone and is declared in `desired-state/dns.yaml`.