https://github.com/primer/github-syntax-theme-generator

Uses a prettylights theme object to generate syntax themes for multiple platforms
https://github.com/primer/github-syntax-theme-generator

github syntax-theme

Last synced: about 1 month ago
JSON representation

Uses a prettylights theme object to generate syntax themes for multiple platforms

• Host: GitHub
• URL: https://github.com/primer/github-syntax-theme-generator
• Owner: primer
• License: mit
• Created: 2016-06-19T13:19:54.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2021-03-22T04:37:13.000Z (almost 4 years ago)
• Last Synced: 2024-11-03T17:43:17.381Z (about 2 months ago)
• Topics: github, syntax-theme
• Language: JavaScript
• Homepage:
• Size: 71.3 KB
• Stars: 158
• Watchers: 8
• Forks: 33
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub syntax theme generators

[![NPM version](https://img.shields.io/npm/v/github-syntax-theme-generator.svg)](https://www.npmjs.org/package/github-syntax-theme-generator)

[![Build Status](https://travis-ci.org/primer/github-syntax-theme-generator.svg?branch=master)](https://travis-ci.org/primer/github-syntax-theme-generator)

> The GitHub syntax theme generator will generate themes for multiple platforms based on the GitHub syntax theme.

## Install

All of the built themes in this package are distributed at separate repositories. It's recommended that you install one of these if you're looking for a specific theme.

### CSS

The CSS syntax theme is based on a custom syntax highlighter in use by GitHub. The prefixes to the classes are `.pl-` for Prettylights.

- [github-syntax-light](https://github.com/primer/github-syntax-light)

- [github-syntax-dark](https://github.com/primer/github-syntax-dark)

### [Codemirror][codemirror]

The [Codemirror][codemirror] syntax theme is generated by the [codemirror](./lib/adapters/codemirror.js) adapter.

- [codemirror-github-light](https://github.com/primer/codemirror-github-light)

- [codemirror-github-dark](https://github.com/primer/codemirror-github-dark)

### [Atom][atom]

The [Atom][atom] theme is built by `apm` converted from the [TextMate][tm] theme.

- [github-atom-light-syntax](https://github.com/primer/github-atom-light-syntax)

- [github-atom-dark-syntax](https://github.com/primer/github-atom-dark-syntax)

### [TextMate][tm]

For [TextMate][tm] or any other TextMate compatible editors, you can use the [github-textmate-theme](https://github.com/primer/github-textmate-theme).

## Development

Clone this repository and after `npm install`. Run

```

$ npm run build

```

This will run the script that will build all the themes. The themes are built from the `json` files in the `lib/themes` folder.

## Adapters

The theme adapters are located in `./lib/adapters/` directory. Each one will complete a specific task to build that theme.

## Contributing

If you would like to see the theme compiled for another platform, we welcome pull requests.

## License

[MIT](./LICENSE) © [GitHub](https://github.com/)

[vscode]: https://code.visualstudio.com/

[codemirror]: https://codemirror.net/

[tm]: https://github.com/textmate/textmate

[atom]: https://atom.io/