docs: migrate to the shared @coreui/astro-docs engine#486
Open
mrholek wants to merge 13 commits into
Open
Conversation
Replace the Gatsby-based docs site with the @coreui/astro-docs engine: Astro content collections, live component examples, generated API tables, and config-driven CDN/SRI placeholders.
- Declare the published packages the docs import (@coreui icons/utils/ internal-links/icon-react|vue/icons-pro/chart add-ons, react-imask, date-fns) and add the docs package version, so a plain yarn install builds the docs without the workspace yarn-link step (findSource reads base styling from the sibling library repo). - Resolve @coreui/chartjs via require.resolve so it survives dependency hoisting. - Drop the unused Gatsby remark plugin packages and dependency overrides, and the stale docs-old lint ignores.
The engine now supplies what was constant on every example: `lang` (the
edition default) everywhere, plus the vanilla `name`/`componentName` (filled by
remark-example-meta). Vanilla examples are now just `<Example code={…} />`.
The docs engine resolves the base SCSS from the @coreui/coreui package; it was only found via the dev-workspace sibling repo. Declaring it as a docs dependency lets findSource resolve it from node_modules, so a standalone clone builds the docs without the workspace layout.
…s scheme Old absolute links (coreui.io/docs/4.0/... and the version-less coreui.io/docs/...) pointed at a docs URL scheme that no longer exists. Repoint them to the current coreui.io/bootstrap/docs/... (where the shared utilities/layout/etc. live), and drop stray quote characters in a few URLs.
… choke on docs deps @astrojs/react@5 (a packages/docs dependency) requires Node >=22.12, which fails the install on the matrix's 20.x leg. The library itself doesn't use it, so skip the engine check during install and keep testing the lib on Node 20.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrates this repository's documentation from the Hugo site to the shared
@coreui/astro-docsAstroengine, so every CoreUI edition's docs build from one engine.
Highlights
@coreui/astro-docs(plus
@coreui/astro-docs-api-generatorfor the React/Vue API tables) and@coreui/internal-linksfor cross-framework links. A plainyarn install/CI builds the docs without any local workspace.
SCSS now provided by the engine.
codesource per example,edition-default language, customization snippets read from the engine via the
@docs/prefix, and colour/data-driven examples generated from data maps(theme colours, breakpoints) instead of hardcoded markup.
coreui.io/docs/4.0links repointed to the currentbootstrap/docsscheme, restoreddata-coreui-theme/docs-example-colsmodifiers, markdown (
.md/ llms) export fixes, and assorted markup repairs.No
dist/is committed; the docs build green.