💻 Visit stormsoftware.com to stay up to date with this developer

[!IMPORTANT] This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be available through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.

Cyclone UI - Shiki Themes

A package containing various shiki themes for the Cyclone UI.

• Quick Features
• Installing
• Usage
• Reduced Package Size
• Development
  • Building
  • Running unit tests
  • Linting
• Storm Workspaces
• Roadmap
• Support
• License
  • Documentation
• Changelog
• Contributing
• Contributors

Quick Features

• Six Shiki themes: light, light dimmed, light high contrast, dark, dark dimmed, and dark high contrast
• Theme colors generated from the Cyclone UI design tokens
• Plain JSON files with no runtime code

Installing

Using pnpm:

pnpm add -D @cyclone-ui/shiki

npm install -D @cyclone-ui/shiki

yarn add -D @cyclone-ui/shiki

Usage

Register a theme when you create a highlighter, then pass the theme id:

import { createHighlighter } from "shiki";
import theme from "@cyclone-ui/shiki/dark/theme.json" with { type: "json" };

const highlighter = await createHighlighter({
  themes: [theme],
  langs: ["javascript"]
});

const html = highlighter.codeToHtml("const x = 1", {
  lang: "javascript",
  theme: "cyclone-dark"
});

The theme ids are cyclone-light, cyclone-light-dimmed, cyclone-light-high-contrast, cyclone-dark, cyclone-dark-dimmed, and cyclone-dark-high-contrast. See the package documentation for details.

Reduced Package Size

This project has no bundling step. The build copies the src folder, which holds the generated theme JSON files, to dist.

Development

This project is built using Nx. As a result, many of the usual commands are available to assist in development.

To set up a checkout, clone the repository and run pnpm install in the repository root. Razorwind generates the theme files. Do not edit them by hand. Change the token JSON files in packages/tokens/src/tokens, then run pnpm nx run monorepo:generate-themes.

Building

Run nx build shiki to build the library.

Running unit tests

Run nx test shiki to execute the unit tests via Vitest.

Linting

Run nx lint shiki to run ESLint on the package.

Storm Workspaces

Storm workspaces are built using Nx, a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft. Building on top of Nx, the Open System provides a set of tools and patterns that help you scale your monorepo to many teams while keeping the codebase maintainable.

Roadmap

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Support

Reach out to the maintainer at one of the following places:

• Contact
• GitHub discussions
• [email protected]

License

This project is licensed under the Apache License, Version 2.0. Feel free to edit and distribute this template as you like.

  Copyright (C) 2023 - 2024 Storm Software

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

See LICENSE for more information.

Documentation

All documentation is licensed under the Creative Commons (attribute) license.

Changelog

This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented in the CHANGELOG file

Contributing

First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please try to create bug reports that are:

• Reproducible. Include steps to reproduce the problem.
• Specific. Include as much detail as possible: which version, what environment, etc.
• Unique. Do not duplicate existing opened issues.
• Scoped to a Single Bug. One bug per report.

Please adhere to this project's code of conduct.

You can use markdownlint-cli to check for common markdown style inconsistency.

Contributors

Thanks goes to these wonderful people (emoji key):

Patrick Sullivan 🎨 💻 🔧 📖 ⚠️	Tyler Benning 🎨	Stormie 🚧
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

Storm Software is an open source software development organization and creator of Acidic, StormStack and StormCloud.

Our mission is to make software development more accessible. Our ideal future is one where anyone can create software without years of prior development experience serving as a barrier to entry. We hope to achieve this via LLMs, Generative AI, and intuitive, high-level data modeling/programming languages.

If this sounds interesting, and you would like to help us in creating the next generation of development tools, please reach out on our website!