mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
ea92a0baf8
- Changed project title and tagline in docusaurus.config.js to reflect the new branding. - Updated package.json and package-lock.json to rename the project to gregwiki-docs-site. - Adjusted sidebar and documentation files to align with the new project structure and naming conventions. - Enhanced documentation content for clarity and consistency across various sections. - Added Prettier as a development dependency for code formatting. This commit aligns the project with the new branding and improves overall documentation quality.
39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
# gregWiki — gregFramework documentation
|
|
|
|
This repository contains the **Docusaurus site** (`docusaurus.config.js`, `src/`, `sidebars.js`) and all **Markdown/MDX content** under [`docs/`](./docs/). Published docs use the route base path **`/wiki`**.
|
|
|
|
## Local development
|
|
|
|
```bash
|
|
npm install
|
|
npm run start
|
|
```
|
|
|
|
Production build:
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
Optional: refresh the legacy GitHub Wiki mirror from a sibling `../.wiki/` clone under `gregFramework/` — see [`docs/getting-started/documentation-layout.md`](./docs/getting-started/documentation-layout.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`):
|
|
|
|
```bash
|
|
docker compose up --build
|
|
# or
|
|
docker build -t gregwiki-docs .
|
|
docker run --rm -p 3000:3000 gregwiki-docs
|
|
```
|
|
|
|
## Related repositories
|
|
|
|
The [`gregFramework`](https://github.com/mleem97/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.
|