Skip to content

chore: remove Starlight/DocFX leftovers and split remark plugin#162

Open
viktorkombov wants to merge 11 commits into
masterfrom
vkombov/remove-docfx-starlight-leftovers
Open

chore: remove Starlight/DocFX leftovers and split remark plugin#162
viktorkombov wants to merge 11 commits into
masterfrom
vkombov/remove-docfx-starlight-leftovers

Conversation

@viktorkombov
Copy link
Copy Markdown
Contributor

Description:

Cleans up residual Starlight and DocFX references following the migration to the custom Astro framework.

Root astro.config.ts — replaced broken, unused config (called undefined starlight(), referenced non-existent override components) with a minimal stub pointing consumers to the actual configs under docs.

Starlight cleanup:

  • Removed deprecated starlight option from CreateDocsSiteOptions and updated its JSDoc examples
  • Removed dead starlight: {} option from angular and xplat configs
  • Updated Starlight/DocFX-specific wording in comments across integration.ts, platform.ts, sidebar.ts, content.config.ts, ig-theme.scss, custom.css, ThemingWidget.astro
  • Removed broken sync:en/jp/kr scripts from package.json (referenced non-existent sync-docfx.mjs)
  • Updated .env.example to use generic path examples

Remark plugin refactor:

  • Deleted monolithic remark-docfx.ts (420 lines) — removed dead code: <code-view> transformer, rehypeCodeView, StackBlitz/CodeSandbox embed handlers (used in 0 MDX files; the only .md files with these patterns are excluded from the build)
  • Replaced with three focused plugins: remark-env-vars.ts, remark-md-links.ts, remark-html-transforms.ts
  • Fixed the single remaining <code-view> in an MDX file to use the <Sample> component

@viktorkombov viktorkombov requested a review from dobromirts May 13, 2026 09:36
viktorkombov and others added 6 commits May 13, 2026 12:40
…arations

- Remove all nav HTML prefetch logic from siteMetaIntegration:
  stripScripts(), absolutifyNavUrls(), extractOuterHtml() helpers,
  _navHtmlCache, IG nav fetch block, AppBuilder nav fetch block
- Remove getNavConfig and JSDOM imports; remove prefetchNav /
  prefetchAppBuilderNav deprecated options from SiteMetaOptions
- The nav-html virtual module is kept (consumed by igniteui-astro-
  components) but now only exports theming config (themeApiUrl,
  widgetScriptSrc, platform, navLang) plus empty/false stubs for
  nav HTML fields — GlobalNavBar/GlobalFooter now fetch nav at
  request time via fetchIgNav()
- Replace stale inline virtual-module declarations in
  docs/angular/src/env.d.ts with a reference directive
  (matching docs/xplat/src/env.d.ts)
- Remove stale getNavConfig JSDoc example from platform.ts
- Remove stale header/footer prefetch comment from ThemingWidget.astro
- Remove js-yaml dependency (sidebar now uses JSON only)
- Strip empty prefetched/headerHtml/footerHtml stubs from
  virtual:docs-template/nav-html load handler (these were always
  hardcoded to empty strings after the nav prefetch removal)
@dobromirts

This comment was marked as resolved.

@dobromirts
Copy link
Copy Markdown
Contributor

Depends on IgniteUI/igniteui-astro-components#36 and the version release based on it.

…to vkombov/remove-docfx-starlight-leftovers
@ChronosSF
Copy link
Copy Markdown
Member

@copilot resolve the merge conflicts in this pull request

Co-authored-by: ChronosSF <2188411+ChronosSF@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI commented May 19, 2026

@copilot resolve the merge conflicts in this pull request

Resolved — the only conflict was in README.md (both the PR branch and master had updated it). Merged origin/master and kept master's version since PR #176 specifically improved the README. Commit: 5125f40.

Copilot AI requested a review from ChronosSF May 19, 2026 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants