npm - @chassis-ui/docs - Versions diffs - 0.1.0 → 0.1.2 - Mend

@chassis-ui/docs 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

package/README.md +1 -1
package/index.ts +1 -1
package/package.json +5 -8
package/src/components/Card.astro +19 -0
package/src/layouts/BaseLayout.astro +1 -0
package/src/layouts/footer/Scripts.astro +1 -1
package/src/layouts/head/Head.astro +2 -2
package/src/layouts/head/Stylesheet.astro +1 -2
package/src/libs/chassis.ts +38 -0
package/src/scss/_buttons.scss +0 -4
package/src/scss/main.scss +2 -55
package/src/layouts/head/Scss.astro +0 -9
package/src/libs/remark.ts +0 -205
package/src/scss/search.scss +0 -26

package/README.md CHANGED Viewed

@@ -95,4 +95,4 @@ Contributions are welcome! Please read the contributing guidelines in the main r
 - [Documentation](https://chassis-ui.com/docs)
 - [GitHub Repository](https://github.com/chassis-ui/website)
 - [Issue Tracker](https://github.com/chassis-ui/website/issues)
-- [Chassis UI Website](https://chassis-ui.com)
+- [Chassis UI Website](https://chassis-ui.com)

package/index.ts CHANGED Viewed

@@ -1,7 +1,7 @@
 // Shared libraries for documentation sites
+export * from './src/libs/chassis'
 export * from './src/libs/image'
 export * from './src/libs/layout'
 export * from './src/libs/rehype'
-export * from './src/libs/remark'
 export * from './src/libs/toc'
 export * from './src/libs/utils'

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@chassis-ui/docs",
   "description": "Shared Astro components and layouts for Chassis documentation sites.",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "type": "module",
   "repository": {
     "type": "git",
@@ -37,16 +37,13 @@
     "./js/*": "./src/js/*",
     "./scss/*": "./src/scss/*"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "peerDependencies": {
-    "@chassis-ui/css": "*",
-    "@chassis-ui/icons": "*",
-    "@chassis-ui/tokens": "*",
-    "astro": "^4.0.0 || ^5.0.0"
+    "astro": "^5.0.0"
   },
   "devDependencies": {
-    "@chassis-ui/css": "github:chassis-ui/css#app/docs",
-    "@chassis-ui/icons": "github:chassis-ui/icons#app/docs",
-    "@chassis-ui/tokens": "github:chassis-ui/tokens#app/docs",
     "@docsearch/css": "^3.9.0",
     "@docsearch/js": "^3.9.0",
     "@types/hast": "^3.0.4",

package/src/components/Card.astro ADDED Viewed

@@ -0,0 +1,19 @@
+---
+const { title, body, icon } = Astro.props
+---
+<div class="card large border-0">
+  <div class="card-content">
+    {
+      icon && (
+        <svg class="icon card-icon icon-4xlarge mb-medium">
+          <use xlink:href={`#${icon}`} />
+        </svg>
+      )
+    }
+    <h4 class="card-title">{title}</h4>
+    <p class="card-body">
+      {body}
+    </p>
+  </div>
+</div>

package/src/layouts/BaseLayout.astro CHANGED Viewed

@@ -58,6 +58,7 @@ const mainProps = overrides?.main ?? {}
       thumbnail={thumbnail}
       title={title}
     />
+    <slot name="styles" slot="styles" />
   </head>
   <body {...bodyProps}>
     <Header layout={layout} title={title} />

package/src/layouts/footer/Scripts.astro CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-import { getChassisJsProps } from '@libs/chassis'
+import { getChassisJsProps } from '../../libs/chassis'
 import type { Layout } from '../../libs/layout'
 interface Props {

package/src/layouts/head/Head.astro CHANGED Viewed

@@ -6,7 +6,7 @@ import Stylesheet from './Stylesheet.astro'
 import Favicons from './Favicons.astro'
 import Social from './Social.astro'
 import Analytics from './Analytics.astro'
-import Scss from './Scss.astro'
+import '@scss/docs.scss'
 interface Props {
   description: string
@@ -48,7 +48,7 @@ const pageTitle = isHome
 <script src="../../js/color-modes.js"></script>
 <Stylesheet direction={direction} layout={layout} />
-<Scss />
+<slot name="styles" />
 <Favicons />
 <Social description={description} layout={layout} thumbnail={thumbnail} title={title} />
 <Analytics />

package/src/layouts/head/Stylesheet.astro CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
-import { getChassisCssProps } from '@libs/chassis'
-import { getChassisDocsPath } from '@libs/path'
+import { getChassisCssProps } from '../../libs/chassis'
 import type { Layout } from '../../libs/layout'
 interface Props {

package/src/libs/chassis.ts ADDED Viewed

@@ -0,0 +1,38 @@
+import type { HTMLAttributes } from 'astro/types'
+export function getChassisCssProps(direction: 'rtl' | undefined) {
+  let cxCssLinkHref = '/static/css/chassis'
+  if (direction === 'rtl') {
+    cxCssLinkHref = `${cxCssLinkHref}.rtl`
+  }
+  if (import.meta.env.PROD) {
+    cxCssLinkHref = `${cxCssLinkHref}.min`
+  }
+  cxCssLinkHref = `${cxCssLinkHref}.css`
+  const cxCssLinkProps: HTMLAttributes<'link'> = {
+    href: cxCssLinkHref,
+    rel: 'stylesheet'
+  }
+  return cxCssLinkProps
+}
+export function getChassisJsProps() {
+  let cxJsScriptSrc = '/static/js/chassis.bundle'
+  if (import.meta.env.PROD) {
+    cxJsScriptSrc = `${cxJsScriptSrc}.min`
+  }
+  cxJsScriptSrc = `${cxJsScriptSrc}.js`
+  const cxJsLinkProps: HTMLAttributes<'script'> = {
+    src: cxJsScriptSrc
+  }
+  return cxJsLinkProps
+}

package/src/scss/_buttons.scss CHANGED Viewed

@@ -1,7 +1,3 @@
-@import "@chassis-ui/css/scss/mixins/context";
-@import "@chassis-ui/css/scss/placeholders/context";
-@import "@chassis-ui/css/scss/placeholders/component";
-@import "@chassis-ui/css/scss/placeholders/button";
 // Buttons
 //
 // Custom buttons for the docs.

package/src/scss/main.scss CHANGED Viewed

@@ -1,63 +1,9 @@
-@use "@chassis-ui/tokens/dist/web/chassis-docs/number-large" as large;
-@use "@chassis-ui/tokens/dist/web/chassis-docs/number-medium" as medium;
-@use "@chassis-ui/tokens/dist/web/chassis-docs/number-small" as small;
-// $prefix: cx- !default;
-/*!
- * Chassis - CSS Docs (https://ozgurgunes.github.io/chassis-css//)
- * Copyright 2025 Chassis
- * Licensed under the Creative Commons Attribution 3.0 Unported License.
- * For details, see https://creativecommons.org/licenses/by/3.0/.
- */
-// Dev notes
-//
-// Background information on nomenclature and architecture decisions here.
-//
-// - Chassis - CSS functions, variables, and mixins are included for easy reuse.
-//   Doing so gives us access to the same core utilities provided by Chassis - CSS.
-//   For example, consistent media queries through those mixins.
-//
-// - Chassis - CSS's **docs variables** are prefixed with `$cxd-`.
-//   These custom colors avoid collision with the components Chassis - CSS provides.
-//
-// - Classes are prefixed with `.cxd-`.
-//   These classes indicate custom-built or modified components for the design
-//   and layout of the Chassis - CSS docs. They are not included in our builds.
-//
-// Happy Chassis - CSSing!
-// Load Chassis - CSS variables and mixins
-//@import "chassis-css/scss/functions";
-// fusv-disable
-$enable-grid-classes: true;
-$enable-cssgrid: true;
-//@import "colors";
-// @import "../../../chassis-tokens/dist/tokens/web/chassis_docs_light";
 @import "settings";
-@import "@chassis-ui/tokens/dist/web/chassis-docs/main";
-@import "@chassis-ui/css/scss/functions";
-@import "@chassis-ui/css/scss/tokens";
-@import "@chassis-ui/css/scss/variables";
-@import "@chassis-ui/css/scss/rfs";
-@import "@chassis-ui/css/scss/maps";
-@import "@chassis-ui/css/scss/mixins";
-@import "@chassis-ui/css/scss/grid";
-// fusv-enable
 @import "colors";
 @import "variables";
 @import "fonts";
-// @import "@chassis-ui/css/scss/core";
-// Load docs components
-//@import "colors";
 @import "navbar";
 @import "masthead";
 @import "content";
@@ -74,10 +20,11 @@ $enable-cssgrid: true;
 @import "placeholder-img";
 @import "scrolling";
-// Load docs dependencies
 @import "syntax";
 @import "anchor";
+@import "@docsearch/css/dist/style";
+@import "docsearch";
 /* Hide light-mode things when in dark mode */
 [data-cx-theme="dark"] .display-light {

package/src/layouts/head/Scss.astro DELETED Viewed

@@ -1,9 +0,0 @@
----
----
-<style is:global lang="scss">
-  @import '../../scss/main';
-  @import '../../scss/search';
-</style>
-<slot name="styles" />

package/src/libs/remark.ts DELETED Viewed

@@ -1,205 +0,0 @@
-import type { Root } from 'mdast'
-import type { MdxJsxAttribute, MdxJsxExpressionAttribute } from 'mdast-util-mdx-jsx'
-import type { Plugin } from 'unified'
-import { visit } from 'unist-util-visit'
-// Global registry for config and path functions
-let globalConfigGetter: (() => any) | null = null
-let globalPathGetter: ((path: string) => string) | null = null
-// Registration function for consuming sites to provide their config and path functions
-export function registerRemarkFunctions(
-  getConfig: () => any,
-  getChassisDocsPath: (path: string) => string
-) {
-  globalConfigGetter = getConfig
-  globalPathGetter = getChassisDocsPath
-}
-// [[config:foo]]
-// [[config:foo.bar]]
-const configRegExp = /\[\[config:(?<name>[\w.]+)]]/g
-// [[docsref:/foo]]
-// [[docsref:/foo/bar#baz]]
-const docsrefRegExp = /\[\[docsref:(?<path>[\w./#-]+)]]/g
-// A remark plugin to replace config values embedded in markdown (or MDX) files.
-// For example, [[config:foo]] will be replaced with the value of the `foo` key in the `config.yml` file.
-// Nested values are also supported, e.g. [[config:foo.bar]].
-// Note: this also works in frontmatter.
-// Note: this plugin is meant to facilitate the migration from Hugo to Astro while keeping the differences to a minimum.
-// At some point, this plugin should maybe be removed and embrace a more MDX-friendly syntax.
-export const remarkCxConfig: Plugin<[], Root> = function () {
-  return function remarkCxConfigPlugin(ast, file) {
-    if (containsFrontmatter(file.data.astro)) {
-      replaceInFrontmatter(file.data.astro.frontmatter, replaceConfigInText)
-    }
-    // https://github.com/syntax-tree/mdast#nodes
-    // https://github.com/syntax-tree/mdast-util-mdx-jsx#nodes
-    visit(
-      ast,
-      ['code', 'definition', 'image', 'inlineCode', 'link', 'mdxJsxFlowElement', 'text'],
-      (node) => {
-        switch (node.type) {
-          case 'code':
-          case 'inlineCode':
-          case 'text': {
-            node.value = replaceConfigInText(node.value)
-            break
-          }
-          case 'image': {
-            if (node.alt) {
-              node.alt = replaceConfigInText(node.alt)
-            }
-            node.url = replaceConfigInText(node.url)
-            break
-          }
-          case 'definition':
-          case 'link': {
-            node.url = replaceConfigInText(node.url)
-            break
-          }
-          case 'mdxJsxFlowElement': {
-            node.attributes = replaceConfigInAttributes(node.attributes)
-            break
-          }
-        }
-      }
-    )
-  }
-}
-// A remark plugin to add versionned docs links in markdown (or MDX) files.
-// For example, [[docsref:/foo]] will be replaced with the `/docs/${docs_version}/foo` value with the `docs_version`
-// value being read from the `config.yml` file.
-// Note: this also works in frontmatter.
-// Note: this plugin is meant to facilitate the migration from Hugo to Astro while keeping the differences to a minimum.
-// At some point, this plugin should maybe be removed and embrace a more MDX-friendly syntax.
-export const remarkCxDocsref: Plugin<[], Root> = function () {
-  return function remarkCxDocsrefPlugin(ast, file) {
-    if (containsFrontmatter(file.data.astro)) {
-      replaceInFrontmatter(file.data.astro.frontmatter, replaceDocsrefInText)
-    }
-    // https://github.com/syntax-tree/mdast#nodes
-    // https://github.com/syntax-tree/mdast-util-mdx-jsx#nodes
-    visit(
-      ast,
-      [
-        'code',
-        'definition',
-        'image',
-        'inlineCode',
-        'link',
-        'mdxJsxFlowElement',
-        'mdxJsxTextElement',
-        'text'
-      ],
-      (node) => {
-        switch (node.type) {
-          case 'code':
-          case 'inlineCode':
-          case 'text': {
-            node.value = replaceDocsrefInText(node.value)
-            break
-          }
-          case 'definition':
-          case 'link': {
-            node.url = replaceDocsrefInText(node.url)
-            break
-          }
-          case 'mdxJsxFlowElement':
-          case 'mdxJsxTextElement': {
-            node.attributes = replaceDocsrefInAttributes(node.attributes)
-            break
-          }
-        }
-      }
-    )
-  }
-}
-export function replaceConfigInText(text: string) {
-  return text.replace(configRegExp, (_match, path) => {
-    const value = getConfigValueAtPath(path)
-    if (!value) {
-      throw new Error(`Failed to find a valid configuration value for '${path}'.`)
-    }
-    return value
-  })
-}
-function replaceConfigInAttributes(attributes: (MdxJsxAttribute | MdxJsxExpressionAttribute)[]) {
-  return attributes.map((attribute) => {
-    if (attribute.type === 'mdxJsxAttribute' && typeof attribute.value === 'string') {
-      attribute.value = replaceConfigInText(attribute.value)
-    }
-    return attribute
-  })
-}
-export function replaceDocsrefInText(text: string) {
-  if (!globalPathGetter) {
-    throw new Error('remark functions not registered. Call registerRemarkFunctions() first.')
-  }
-  return text.replace(docsrefRegExp, (_match, path) => {
-    return globalPathGetter!(path)
-  })
-}
-function replaceDocsrefInAttributes(attributes: (MdxJsxAttribute | MdxJsxExpressionAttribute)[]) {
-  return attributes.map((attribute) => {
-    if (attribute.type === 'mdxJsxAttribute' && typeof attribute.value === 'string') {
-      attribute.value = replaceDocsrefInText(attribute.value)
-    }
-    return attribute
-  })
-}
-function getConfigValueAtPath(path: string) {
-  if (!globalConfigGetter) {
-    throw new Error('remark functions not registered. Call registerRemarkFunctions() first.')
-  }
-  const config = globalConfigGetter()
-  const value = path.split('.').reduce((values, part) => {
-    if (!values || typeof values !== 'object') {
-      return undefined
-    }
-    return (values as any)?.[part]
-  }, config as unknown)
-  return typeof value === 'string' ? value : undefined
-}
-function replaceInFrontmatter(
-  record: Record<string, unknown>,
-  replacer: (value: string) => string
-) {
-  for (const [key, value] of Object.entries(record)) {
-    if (typeof value === 'string') {
-      record[key] = replacer(value)
-    } else if (Array.isArray(value)) {
-      record[key] = value.map((arrayValue) => {
-        return typeof arrayValue === 'string'
-          ? replacer(arrayValue)
-          : typeof arrayValue === 'object'
-            ? replaceInFrontmatter(arrayValue, replacer)
-            : arrayValue
-      })
-    }
-  }
-  return record
-}
-function containsFrontmatter(data: unknown): data is { frontmatter: Record<string, unknown> } {
-  return data != undefined && typeof data === 'object' && 'frontmatter' in data
-}

package/src/scss/search.scss DELETED Viewed

@@ -1,26 +0,0 @@
-$prefix: cx- !default;
-/*!
- * Chassis - CSS Docs (https://ozgurgunes.github.io/chassis-css//)
- * Copyright 2025 Chassis
- * Licensed under the Creative Commons Attribution 3.0 Unported License.
- * For details, see https://creativecommons.org/licenses/by/3.0/.
- */
-//@import "../../../chassis-tokens/dist/tokens/web/chassis_docs_light";
-@import "settings";
-@import "@chassis-ui/tokens/dist/web/chassis-docs/main";
-@import "@chassis-ui/css/scss/functions";
-@import "@chassis-ui/css/scss/tokens";
-@import "@chassis-ui/css/scss/variables";
-@import "@chassis-ui/css/scss/rfs";
-@import "@chassis-ui/css/scss/maps";
-@import "@chassis-ui/css/scss/mixins";
-@import "@chassis-ui/css/scss/grid";
-@import "variables";
-@import "@docsearch/css/dist/style";
-@import "docsearch";