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.
59 lines
1.1 KiB
Markdown
59 lines
1.1 KiB
Markdown
# Greg Wiki (Docusaurus)
|
|
|
|
This folder is configured as a Docusaurus site using the existing Markdown wiki files.
|
|
|
|
## Local run
|
|
|
|
```bash
|
|
npm install
|
|
npm run start
|
|
```
|
|
|
|
## Production build
|
|
|
|
```bash
|
|
npm run build
|
|
npm run serve
|
|
```
|
|
|
|
## Coolify deployment notes
|
|
|
|
- Build command: `npm install ; npm run build`
|
|
- Start command: `npm run serve -- --host 0.0.0.0 --port $PORT`
|
|
- Port: `3000` (or use Coolify `$PORT`)
|
|
|
|
If you use Docker deployment mode in Coolify, this repo includes a `Dockerfile`.
|
|
|
|
## Multi-repo wiki import
|
|
|
|
This workspace can import GitHub wiki pages for every repository of one or more owners.
|
|
|
|
- Config file: `wiki-import.config.json`
|
|
- Import script: `scripts/import-wikis.mjs`
|
|
|
|
### Configure owners
|
|
|
|
Edit `wiki-import.config.json`:
|
|
|
|
```json
|
|
{
|
|
"owners": [
|
|
{
|
|
"name": "mleem97",
|
|
"destination": "Repos/mleem97"
|
|
}
|
|
],
|
|
"includeArchived": false,
|
|
"perPage": 100
|
|
}
|
|
```
|
|
|
|
### Run import
|
|
|
|
```bash
|
|
npm run import:wikis:dry
|
|
npm run import:wikis
|
|
```
|
|
|
|
Imported docs are placed under owner/repo folders such as `Repos/mleem97/<repo>/` and automatically appear in the Docusaurus sidebar.
|