Releases: lancher-dev/jaad
Releases · lancher-dev/jaad
Release list
v0.9.1
v0.9.0
What's Changed
Added
- Documentation can now be written in more than one language: name the directories under
docs/after language codes and JAAD builds one site per language, with a switcher in the header beside the theme toggle by @Kasui92 - Added
translationKey, which pairs a page with its translations when their slugs differ, so a language can translate its file and directory names too by @Kasui92 - Added the
uioption, which replaces any of JAAD's own interface strings per locale; a key left out keeps its English default by @Kasui92 - Added the
localesoption, for the rare tree where directory detection guesses wrong by @Kasui92 - Added
label,order,draft,keywords,author,ogImageandlastUpdatedto page frontmatter, each overriding what the file tree or the page body already supplies by @Kasui92 lastUpdatedis shown under the page, formatted for its language by @Kasui92- Localised pages declare
hreflangalternates,x-defaultandog:locale:alternate, and each language gets its own search index andllms.txtby @Kasui92 - Scaffolded projects now arrive with an
AGENTS.mddescribing the project to coding agents, and aCLAUDE.mdthat defers to it by @Kasui92
Changed
- JAAD no longer brings Tailwind with it. The stylesheet is compiled when the package is published, so installing JAAD adds nothing to your
node_modulesand leaves your Vite configuration alone. A project that relied on JAAD providing Tailwind for its own pages now adds it itself, as thesitetemplate does by @Kasui92 - The documentation stylesheet is wrapped in a cascade layer, so a rule you write on a
.docs-*element now wins where it used to lose by @Kasui92 og:localecarries a territory, as Open Graph requires:en_GBrather thanenby @Kasui92- The opening page now respects
draftand frontmatterorder, which changes which URL the sitemap leaves out by @Kasui92 - The
sitetemplate declares its own Tailwind dependency, and the two templates share their common files by @Kasui92
Fixed
- A preset theme reaches pages outside the documentation again; the 404 page and pages built on the exported
Page.astrorendered in the default palette by @Kasui92 - Structured data roots its breadcrumb in the page's own language instead of the default one by @Kasui92
- The table of contents no longer observes every heading twice on first load, nor leaks an observer per navigation by @Kasui92
x-defaultno longer disappears on a page that has no translation into the default language by @Kasui92- A pinned
localeslist no longer crashes when there is no documentation directory by @Kasui92 create-jaadtreats every spelling of the current directory as--here, including./and an absolute path by @Kasui92
Full Changelog: v0.8.3...v0.9.0
v0.8.3
What's Changed
Added
- Added default JAAD
faviconto templates by @Kasui92 - Added SearchPalette icon for mobile view and in
layout/Page.astroexport by @Kasui92
Updated
- Moved styles to folder in
create-jaadby @Kasui92 - Added missing
tsconfigandgitignoreto templates by @Kasui92 - Various refinements in the documentation by @Kasui92
- Updated deployment method on GitHub Pages and added Astro adapters for other providers by @Kasui92
- Implement
withBaseutility for consistent base URL handling by @Kasui92
Full Changelog: v0.8.1...v0.8.3
v0.8.1
What's Changed
Changed
- Bundled theme presets (
dracula,nord,one-dark,tokyo-night,gruvbox,rose-pine,rose-pine-moon,catppuccin) are now sourced from@lancher-dev/jaamd's own theme manifest instead of being duplicated as local stylesheets, following the upgrade to@lancher-dev/jaamd0.9.2 by @Kasui92 - JAAD and JAAMD now exchange colours through a single bridge stylesheet by @Kasui92
- Documented the
:::tocdirective for generating an inline table of contents by @Kasui92
Fixed
- Following a table of contents or heading link no longer scrolls past the heading; the offset used to be applied twice by @Kasui92
Full Changelog: v0.8.0...v0.8.1
v0.8.0
What's Changed
Added
- Added
@lancher-dev/jaad/layouts/Page.astro, a public layout that puts the documentation header and footer around a page of your own by @Kasui92
Changed
docsis now the defaultcreate-jaadtemplate, and--templateis optional everywhere, including non-interactive environments by @Kasui92- The scaffolder now copies its templates from real files instead of building them in code, so generated projects arrive formatted by @Kasui92
- Documentation now covers the theme contract for custom layouts, the shapes behind
navigation, the conditions that disable page shortcuts, and the fact thatastrooptions apply only through@lancher-dev/jaad/siteby @Kasui92 - The official site now answers an unknown URL with its own not found page by @Kasui92
Removed
- Removed
@lancher-dev/jaad/layouts/Base.astro, deprecated in JAAD 0.7 by @Kasui92
Fixed
- The opening documentation page takes its title from frontmatter again, instead of falling back to the first heading by @Kasui92
- Repeated headings on a page now get the same numbered anchors as the rendered output, so every table of contents entry points at its own heading by @Kasui92
--jaad-sidebar-widthnow moves the content gutters with it, and a widened sidebar is no longer pushed off the screen by @Kasui92- Image alt text no longer reaches the search index or the generated page descriptions by @Kasui92
- Bundled layouts, routes and themes resolve in projects whose path contains spaces by @Kasui92
--here --template sitenow stops instead of adding a landing page beside a JAAD configuration it did not write by @Kasui92create-jaad .is treated as--hereby @Kasui92create-jaadexits non-zero when it is cancelled or cannot write the project by @Kasui92create-jaadreads manifests that begin with a byte order mark, and treats a directory holding only.gitas empty by @Kasui92- Printed next steps quote paths that contain spaces by @Kasui92
- The site theme switcher exposes its state to assistive technology by @Kasui92
Upgrade Notes
- Replace
@lancher-dev/jaad/layouts/Base.astroimports with@lancher-dev/jaad/layouts/Page.astro.Base.astroforwarded every prop to that layout, so nothing else about the page changes. --templateis no longer required in non-interactive environments and defaults todocs. Existing--template docsand--template siteinvocations keep working.--here --template siteagainst a project that already has ajaad.config.*now stops with an error and writes nothing. The landing page needsrouteBase: "/docs", which only the project can set, so add both by hand.
Full Changelog: v0.7.1...v0.8.0
v0.7.1
v0.7.0
What's Changed
Added
- Added advanced documentation layout customization through
src/jaad/DocsFrame.astroby @Kasui92 - Added public frame and navigation types under
@lancher-dev/jaad/advancedby @Kasui92
Changed
- Pages outside the documentation now use their own Astro layouts and no longer inherit the documentation chrome by @Kasui92
- The
sitetemplate now creates a local layout and landing page by @Kasui92 --herevalidates existing projects before writing and stops safely when configuration files require a manual merge by @Kasui92- Search,
llms.txtand raw Markdown routes are now emitted belowrouteBaseby @Kasui92 - Astro passthrough options now use Astro's public configuration types by @Kasui92
- Documentation has been reorganized around shorter, task-focused guides by @Kasui92
Fixed
- Canonical URLs and local social images are omitted when no public site URL is available by @Kasui92
- Social images are detected from existing files instead of assuming
/og-image.pngby @Kasui92 - Ambiguous paths, duplicate slugs and unsupported nesting now stop the build with actionable errors by @Kasui92
- JAAD no longer installs a site-wide
404page when documentation is mounted below the site root by @Kasui92 - Existing dependencies, scripts and project files are preserved more reliably by
--hereby @Kasui92
Deprecated
@lancher-dev/jaad/layouts/Base.astrois deprecated and will be removed in JAAD 0.8.0. Pages outside the documentation should use a local Astro layout by @Kasui92
Upgrade Notes
- Existing
Base.astroimports continue to work in JAAD 0.7, but should be migrated to a local layout before upgrading to 0.8.0 . - With
routeBase: "/docs", generated documentation assets now live at/docs/search-index.json,/docs/llms.txtand/docs/**/*.md. - Documentation supports top-level pages and one directory level for chapters. Deeper nesting and paths that become identical after removing numeric prefixes are rejected.
Full Changelog: v0.6.1...v0.7.0
v0.6.1
What's Changed
Changed
- Improved the interactive
create-jaadexperience with clearer prompts and next-step guidance by @Kasui92 - Updated generated projects and the documentation site to Astro 7.3.1 by @Kasui92
- Refreshed project branding and README content by @Kasui92
Full Changelog: v0.6.0...v0.6.1
v0.6.0
What's Changed
Added
- Interactive
create-jaadsetup by @Kasui92 docsandsitetemplates for documentation-only projects or sites with a landing page by @Kasui92- New
--templateand--installCLI options by @Kasui92
Changed
- Non-interactive usage now requires all setup options explicitly by @Kasui92
- Updated project dependencies and documentation by @Kasui92
Full Changelog: v0.5.0...v0.6.0
v0.5.0
What's Changed
Added
- Full support for Astro's
baseoption across navigation, public assets, search, redirects, raw Markdown routes, structured data andllms.txtby @Kasui92 - Permanent compatibility redirect from the opening page's named URL to the documentation root by @Kasui92
- Warning when an Astro index page conflicts with documentation mounted at the site root by @Kasui92
Changed
- Documentation now mounts at
/by default, and the first sorted Markdown page owns the configuredrouteBaseby @Kasui92 - Set
routeBase: "/docs"to keep a landing page at the site root by @Kasui92 - URL generation, integration setup and documentation navigation have been reorganized into cohesive modules by @Kasui92
- Navigation data and page headings are now computed once per page by @Kasui92
Fixed
- Opening-page redirects are no longer included as canonical content in the sitemap by @Kasui92
- Documentation URLs now consistently follow filename-derived slugs, including filenames containing special characters by @Kasui92
- Consumer tests now use isolated package archives and report command failures with useful diagnostics by @Kasui92
Full Changelog: v0.4.0...v0.5.0