Merge pull request 'refactor: reference diagrams-drawio' (#1) from refactor/diagrams-drawio-reference into main
validate / validate (push) Successful in 5s
validate / validate (push) Successful in 5s
This commit was merged in pull request #1.
This commit is contained in:
@@ -16,7 +16,7 @@ metadata:
|
|||||||
framework: Diátaxis
|
framework: Diátaxis
|
||||||
hermes:
|
hermes:
|
||||||
tags: [docusaurus, documentation, diataxis, drawio, mdx, react-flow, gitea, ci-cd, pages]
|
tags: [docusaurus, documentation, diataxis, drawio, mdx, react-flow, gitea, ci-cd, pages]
|
||||||
related_skills: [drawio-main, gitea-repository-operations]
|
related_skills: [diagrams-drawio, gitea-repository-operations]
|
||||||
compatibility: Designed for Docusaurus v3. Works with Cline, Claude Code, GitHub Copilot, OpenAI Codex, and other compatible agent environments
|
compatibility: Designed for Docusaurus v3. Works with Cline, Claude Code, GitHub Copilot, OpenAI Codex, and other compatible agent environments
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -169,7 +169,7 @@ Use `@xyflow/react` when validated documentation data needs an interactive roadm
|
|||||||
|
|
||||||
### Draw.io source diagrams
|
### Draw.io source diagrams
|
||||||
|
|
||||||
When a page needs a Draw.io diagram, keep the editable `.drawio` XML in the documentation repository and render that source directly with `docusaurus-plugin-drawio`. Load `drawio-main` to author or change the diagram, then follow [references/drawio-source-diagrams.md](references/drawio-source-diagrams.md) to install the plugin with pnpm, register it, consume the source from MDX with `@theme/Drawio` and `!!raw-loader!`, select multi-page diagrams, and verify the production build and browser rendering. An exported PNG/SVG alone is not an onboarded source diagram.
|
When a page needs a Draw.io diagram, keep the editable `.drawio` XML in the documentation repository and render that source directly with `docusaurus-plugin-drawio`. Load `diagrams-drawio` to author or change the diagram, then follow [references/drawio-source-diagrams.md](references/drawio-source-diagrams.md) to install the plugin with pnpm, register it, consume the source from MDX with `@theme/Drawio` and `!!raw-loader!`, select multi-page diagrams, and verify the production build and browser rendering. An exported PNG/SVG alone is not an onboarded source diagram.
|
||||||
|
|
||||||
### Interactive Elements (Use Sparingly)
|
### Interactive Elements (Use Sparingly)
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ Use this workflow when a Docusaurus v3 site must render an editable Draw.io sour
|
|||||||
- Commit the editable `.drawio` XML in the documentation repository.
|
- Commit the editable `.drawio` XML in the documentation repository.
|
||||||
- Render that source directly in MDX; do not make a PNG/SVG export the only authoritative artifact.
|
- Render that source directly in MDX; do not make a PNG/SVG export the only authoritative artifact.
|
||||||
- Keep the source adjacent to, or in a clearly named diagram directory near, the page that consumes it.
|
- Keep the source adjacent to, or in a clearly named diagram directory near, the page that consumes it.
|
||||||
- Use the global `drawio-main` skill to author and validate diagram content.
|
- Use the global `diagrams-drawio` skill to author and validate diagram content.
|
||||||
- Use this `documentation-docusaurus` skill to onboard and render the source in Docusaurus.
|
- Use this `documentation-docusaurus` skill to onboard and render the source in Docusaurus.
|
||||||
|
|
||||||
Recommended layout:
|
Recommended layout:
|
||||||
|
|||||||
Reference in New Issue
Block a user