mirror of https://github.com/tabler/tabler.git synced 2026-08-27 12:36:28 +04:00

Files

T

History

Bartek 2711cc5077 Add Accessibility documentation page

Collects color contrast, keyboard focus, screen reader, reduced
motion, and touch target guidance in one place under Getting started,
and links out to the existing per-component notes instead of
duplicating them. Resolves #2892.

2026-08-17 14:53:01 +02:00

.vscode

Migrate preview and docs packages from Eleventy to Astro (#2694 )

2026-07-28 00:09:02 +02:00

assets

Improve docs SEO, performance and content quality (#2841 )

2026-08-11 14:45:31 +02:00

components

Render CDN snippets from one docs helper; keep SRI script for v2.0 (#2886 )

2026-08-17 11:42:33 +02:00

content

Add Accessibility documentation page

2026-08-17 14:53:01 +02:00

layouts

Unify shared/ui props, split demo components, add SCSS-driven tokens (#2872 )

2026-08-14 01:16:54 +02:00

lib

Render CDN snippets from one docs helper; keep SRI script for v2.0 (#2886 )

2026-08-17 11:42:33 +02:00

pages

Serve the docs as markdown for LLMs (llms.txt) (#2850 )

2026-08-11 23:06:19 +02:00

.env.example

Improve docs SEO, performance and content quality (#2841 )

2026-08-11 14:45:31 +02:00

.gitignore

Migrate preview and docs packages from Eleventy to Astro (#2694 )

2026-07-28 00:09:02 +02:00

astro.config.mjs

Render docs pages from a content collection instead of file routing (#2849 )

2026-08-11 23:06:19 +02:00

content.config.ts

Render docs pages from a content collection instead of file routing (#2849 )

2026-08-11 23:06:19 +02:00

env.d.ts

Render docs pages from a content collection instead of file routing (#2849 )

2026-08-11 23:06:19 +02:00

package.json

Improve docs SEO, performance and content quality (#2841 )

2026-08-11 14:45:31 +02:00

README.md

Improve docs SEO, performance and content quality (#2841 )

2026-08-11 14:45:31 +02:00

tsconfig.json

Render docs pages from a content collection instead of file routing (#2849 )

2026-08-11 23:06:19 +02:00

vercel.json

Improve docs SEO, performance and content quality (#2841 )

2026-08-11 14:45:31 +02:00

README.md

@tabler/docs

Documentation site for the Tabler ecosystem, deployed at docs.tabler.io. Built with Astro and MDX.

Development

From the repository root:

pnpm install
pnpm --dir docs run dev

The dev server runs at http://localhost:3010.

Structure

Pages live at the package root (srcDir: '.'), not in src/:

Path	Purpose
`pages/`	MDX content pages (`ui/`, `icons/`, `illustrations/`, `emails/`) plus `sitemap.xml.ts`, `robots.txt.ts` and `404.astro`
`layouts/`	`DocsLayout.astro` (full page shell) and `DocsMdxLayout.astro` (MDX adapter)
`components/`	Docs-only components (`Example`, `DocsMenu`, `DocsCard`, …)
`assets/`	Docs CSS/JS sources, copied into `public/` at build time
`public/`	Static assets; `dist/`, `preview/` and `static/` subdirs are synced from other packages by the `copyAssets` integration

Shared components, layouts and data come from ../shared (aliases @shared, @ui, @data).

The sidebar tree is not generated from the filesystem — it is defined in ../shared/data/docs.json. A new page needs an entry there to be reachable (see components/DocsMenu.astro).

Build

pnpm --dir docs run build

Static output goes to dist/ and, via the @astrojs/vercel adapter, to .vercel/output/. Redirects for renamed pages are defined in astro.config.mjs (redirects).

Checks

pnpm --dir docs run type-check
pnpm run lint-md
pnpm run check-docs-links # validates internal links at the source level (also part of `pnpm lint`)