Skip to content

Commit e7feb44

Browse files
authored
chore(docs): document Nexus Mods page authoring workflow (#18)
1 parent ed5d0f1 commit e7feb44

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,29 @@ git commit -m "chore: update CommonLibSSE-NG submodule"
226226

227227
---
228228

229+
### Nexus Mods Page
230+
231+
The `<!-- nexus:start/end -->` block at the top of `README.md` is the **source of truth** for Requirements, Installation, and Compatibility. `docs/nexus-page.md` holds the rest of the BBCode page (overview, tagline, credits).
232+
233+
To update the Nexus page:
234+
235+
1. Edit Requirements/Installation/Compatibility inside the `<!-- nexus:start/end -->` block in `README.md`.
236+
2. Edit overview, tagline, and credits directly in `docs/nexus-page.md`.
237+
> **Do not edit** the `<!-- generated:start/end -->` block in `docs/nexus-page.md` — it is overwritten every time the script runs.
238+
3. Generate the combined BBCode output:
239+
240+
```bash
241+
python3 scripts/generate-nexus-page.py
242+
243+
# Or pipe straight to the clipboard:
244+
python3 scripts/generate-nexus-page.py | xclip -selection clipboard # Linux
245+
python3 scripts/generate-nexus-page.py | pbcopy # macOS
246+
```
247+
248+
4. Paste the output into the Nexus Mods page editor.
249+
250+
---
251+
229252
### CI
230253

231254
| Workflow | Trigger | What it does |

0 commit comments

Comments
 (0)