Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add unfurl image, improve site metadata #147

Merged
merged 1 commit into from
Nov 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import {defineConfig} from 'vitepress';
import packageJSON from '../../packages/cli/package.json';

const HOSTNAME = 'https://cobalt-ui.pages.dev';

/** @see https://vitepress.dev/reference/site-config */
export default defineConfig({
title: 'Cobalt',
Expand All @@ -13,7 +15,15 @@ export default defineConfig({
['script', {defer: '', src: 'https://static.cloudflareinsights.com/beacon.min.js', 'data-cf-beacon': '{"token": "f5713e86f9aa43278151f2763d6b59ae"}'}],
],
sitemap: {
hostname: 'https://cobalt-ui.pages.dev',
hostname: HOSTNAME,
},
transformHead(context) {
return [
['meta', {name: 'og:title', content: context.pageData.frontmatter.title ? `${context.pageData.frontmatter.title} | Cobalt` : `Cobalt: CI for your Design Tokens`}],
['meta', {name: 'og:description', content: context.pageData.frontmatter.description || 'Use Design Tokens Format Module tokens to generate CSS, Sass, JS/TS, universal JSON, and more.'}],
['meta', {name: 'og:image', content: `${HOSTNAME}/social.png`}],
['meta', {name: 'twitter:card', content: 'summary_large_image'}],
];
},
/** @see https://vitepress.dev/reference/default-theme-config */
themeConfig: {
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/about.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: About
title: About Cobalt
---

# About
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced/ci.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: CI
title: Using Cobalt in CI
---

# CI
# Using Cobalt in CI

Using your preferred CI stack, here’s an example of how you could add Cobalt to your CI. First, we’ll take a `package.json` that had an existing `npm run build` command, and add `co build` script to it:

Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Config
title: Cobalt Config
---

# Config
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/node.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Node.js API
title: Cobalt Node.js API
---

# Node.js API
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/plugin-api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Plugin API
title: Cobalt Plugin API
---

# Plugin API
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/cli.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: CLI
title: Cobalt CLI
---

# CLI
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/modes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Modes
title: Token Modes
---

# Modes
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/tokens.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: tokens.json
title: tokens.json Manifest
---

# tokens.json
Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
# https://vitepress.dev/reference/default-theme-home-page
layout: home

title: 'Cobalt: CI for your design tokens'

hero:
name: Cobalt
text: CI for Design Tokens
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/css.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: CSS
title: CSS Integration
---

# CSS
# CSS Integration

Generate CSS variables from your Design Tokens Format Module (DTFM) tokens.

Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/figma.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Figma
title: Figma Integration
---

# Figma
# Figma Integration

Because Figma doesn’t have a way to export the [Design Tokens Format Module (DTFM)](https://designtokens.org) directly, you’ll need a plugin to export your styles to the DTFM format.

Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/js.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: JS / TS
title: JS + TS Integration
---

# JavaScript + TypeScript
# JavaScript + TypeScript Integration

Generate JavaScript (with TypeScript declarations) from your Design Tokens Format Module (DTFM) tokens.

Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/json.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: JSON
title: JSON Integration
---

# JSON + Native Apps
# JSON + Native App Integration

Generate universal JSON from your Design Tokens Format Module (DTFM) tokens. This is usable by any platform, any language (provided you do a small amount of JSON parsing).

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/other.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Other
title: Other Integrations
---

# Other Integrations
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/sass.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Sass
title: Sass Integration
---

# Sass
# Sass Integration

Generate `.scss` and `.sass` from your Design Tokens Format Module (DTFM) tokens.

Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/style-dictionary.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Style Dictionary
title: Style Dictionary Integration
---

# Style Dictionary
# Style Dictionary Integration

You can migrate your [Style Dictionary](https://amzn.github.io/style-dictionary) tokens to the Design Tokens Format Module (DTFM) standard by running the following command (granted you have [the CLI installed](/guides/cli)):

Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/tailwind.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Tailwind CSS
title: Tailwind CSS Integration
---

# Tailwind CSS
# Tailwind CSS Integration

Generate a [Tailwind CSS](https://tailwindcss.com/) preset from your design tokens.

Expand Down
Binary file added docs/public/social.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/tokens/alias.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Alias
title: Token Alias
---

# Alias
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/border.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Border
title: Border Token
---

# Border
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/color.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: color
title: Color Token
---

# Color
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/cubic-bezier.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Cubic Bézier
title: Cubic Bézier Token
---

# Cubic Bézier
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/dimension.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Dimension
title: Dimension Token
---

# Dimension
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/duration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Duration
title: Duration Token
---

# Duration
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/font-family.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Font Family
title: Font Family Token
---

# Font Family
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/font-weight.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Font Weight
title: Font Weight Token
---

# Font Weight
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/gradient.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Gradient
title: Gradient Token
---

# Gradient
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/group.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Group
title: Token Group
---

# Group
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/link.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Link
title: Link Token
---

# Link
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/number.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Number
title: Number Token
---

# Number
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/shadow.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Shadow
title: Shadow Token
---

# Shadow
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/stroke-style.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Stroke Style
title: Stroke Style Token
---

# Stroke Style
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/transition.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Transition
title: Transition Token
---

# Transition
Expand Down
2 changes: 1 addition & 1 deletion docs/tokens/typography.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Typography
title: Typography Token
---

# Typography
Expand Down
Loading