Files
gregWiki/README.md
Marvin 31cd24b462 chore(docker): compose, entrypoint guard, LF shell script; format with Prettier
- Add docker-compose.yml (build context .) and .gitattributes for entrypoint LF
- README: document docker compose and gregWiki root requirement
- package.json: include docker-compose.yml in npm run format

Made-with: Cursor
2026-04-10 00:05:51 +02:00

1.3 KiB

gregWiki — gregFramework documentation

This repository contains the Docusaurus site (docusaurus.config.js, src/, sidebars.js) and all Markdown/MDX content under docs/. Published docs use the route base path /wiki.

Local development

npm install
npm run start

Production build:

npm run build

Optional: refresh the legacy GitHub Wiki mirror from a sibling ../.wiki/ clone under gregFramework/ — see docs/README.md and npm run wiki:sync / wiki:normalize-i18n.

Deployment (Coolify / CI)

  • Default branch: main — use this for new work and PRs.
  • master: kept in sync with main for hosts that still clone master (e.g. older Coolify defaults). Prefer setting the deployment branch to main in Coolify → Application → Git → Branch.

Docker

Build context must be this repository root (the folder that contains package.json):

docker compose up --build
# or
docker build -t gregwiki-docs .
docker run --rm -p 3000:3000 gregwiki-docs

The gregFramework workspace groups gregCore, gregMods, gregExtensions, gregWiki, and related tools. Source-of-truth code paths for hooks and builds live in those repos, not only in this documentation tree.