Skip to content
openlinkosPublic

About

OpenLinkOS brand assets and the shared VitePress theme for OpenLinkOS and LinkOS sites

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

OpenLinkOS Design

The brand, the design system, and the shared site theme of OpenLinkOS and LinkOS.

npm: ui npm: vitepress-theme CI

English | 简体中文

This repository holds:

  • the brand marks of LinkOS, the organization, with its free public services (such as LinkOS Mirrors), and of OpenLinkOS, its brand for open-source projects (such as Origin);
  • the generated brand assets: favicons, app icons, social images, and README headers;
  • @openlinkos/ui, the design system for apps: design tokens in the W3C DTCG format, framework-free CSS for app shells, sign-in pages, one-page service sites and their components (per brand, light and dark, with contrast checked by tests, and motion that stops for users who prefer less), and a curated Lucide icon set;
  • @openlinkos/vitepress-theme, the VitePress theme every OpenLinkOS and LinkOS site uses for its look, bilingual (English and Simplified Chinese) interface, language detection, and metadata.

Maintainers: see BRAND.md.

Using the design system

Apps link @openlinkos/ui/ui.css, set data-brand on the page, and build their pages from ol- classes. See the package README, the principles, the components and the token reference.

Using the theme

// <site>/.vitepress/theme/index.ts
export { default } from '@openlinkos/vitepress-theme';
// <site>/.vitepress/config.ts
import { defineOpenLinkOSConfig } from '@openlinkos/vitepress-theme/config';

export default defineOpenLinkOSConfig({
  brand: 'origin',
  hostname: 'https://origin.openlinkos.com',
  title: 'Origin',
  locales: {
    root: { description: '…', themeConfig: { nav: [], sidebar: [] } },
    zh: { description: '…', themeConfig: { nav: [], sidebar: [] } },
  },
});

Every page needs a Simplified Chinese counterpart under zh/, and the build checks that the two stay in step. See the theme's README for the options, the language detection and the bilingual rules. playground/ is a small bilingual site that uses the theme: run pnpm build once, then pnpm docs:dev.

License

The code is released under the MIT License. The OpenLinkOS and LinkOS names and marks are not covered by that license; how to use them will be described in the brand guidelines on openlinkos.com.

About

OpenLinkOS brand assets and the shared VitePress theme for OpenLinkOS and LinkOS sites

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages