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.

Sign up for GitHub

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: various fixes #23

Merged
merged 1 commit into from
Jan 29, 2024
Merged

docs: various fixes #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 20 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![tm-grammars](https://img.shields.io/npm/v/tm-grammars?label=tm-grammars&labelColor=080f12&color=1fa669)](https://www.npmjs.com/package/tm-grammars)
[![tm-themes](https://img.shields.io/npm/v/tm-themes?label=tm-themes&labelColor=080f12&color=1fa669)](https://www.npmjs.com/package/tm-themes)

Collection of TextMate [grammars](./packages/tm-grammars/) and [themes](./packages/tm-themes/), converted in JSON format and re-distributed as npm packages. Extracted from Shiki, available for general usage.
Collection of TextMate [grammars](./packages/tm-grammars/) and [themes](./packages/tm-themes/), converted to JSON and re-distributed as npm packages. Extracted from Shiki, available for general usage.

Packages are **automatically updated and published** every day (if there are changes).

Expand All @@ -13,36 +13,38 @@ Packages are **automatically updated and published** every day (if there are cha

### Add a new grammar

1. Fork this repository
2. Install the dependencies with `pnpm i`
3. Add grammar source and metadata to [`sources-grammars.ts`](./sources-grammars.ts)
1. Fork this repository.
2. Install dependencies with `pnpm install`.
3. Add grammar source and metadata to [`sources-grammars.ts`](./sources-grammars.ts).
4. Add a code sample file `<id>.sample` for your language under [`./samples`](./samples). A sample should include a variety of language syntaxes and succinctly capture the idiosyncrasy of a language. Format requirements:
- Space for indentation
- Less than 100 columns if possible
- Link to source in the last line, for example, `# From` https://poignant.guide/book/chapter-5.html`
5. Generate a [personal access token](https://github.com/settings/tokens?type=beta), keep the default, no extra permission is needed. This token is used to query public information from GitHub API and avoid rate limits.
- Space for indentation.
- Less than 100 columns if possible.
- A comment with a link to the source on the last line (e.g. `# From https://poignant.guide/book/chapter-5.html`).
5. Generate a [personal access token](https://github.com/settings/tokens?type=beta) with the default permissions. This token is used to query public information from GitHub API and avoid rate limits.
6. Create a `.env` file and paste your generated token into the file like so:
```bash
GITHUB_TOKEN=your-personal-access-token
```
7. Run `pnpm run fetch` to download the grammar and verify it works via `pnpm run play`
8. Send in the PR!
7. Run `pnpm run fetch` to download the grammar.
8. Run `pnpm run play` to start the playground. Select the new grammar in the left column to verify the accuracy and confirm that the grammar works as expected.
9. Send in the PR!

### Add a new theme

1. Fork this repository
2. Install the dependencies with `pnpm i`
3. Add theme source and metadata to [`sources-themes.ts`](./sources-themes.ts)
4. Generate a [personal access token](https://github.com/settings/tokens?type=beta), keep the default, no extra permission is needed. This token is used to query public information from GitHub API and avoid rate limits.
1. Fork this repository.
2. Install dependencies with `pnpm install`.
3. Add theme source and metadata to [`sources-themes.ts`](./sources-themes.ts).
4. Generate a [personal access token](https://github.com/settings/tokens?type=beta) with the default permissions. This token is used to query public information from GitHub API and avoid rate limits.
5. Create a `.env` file and paste your generated token into the file like so:
```bash
GITHUB_TOKEN=your-personal-access-token
```
6. Run `pnpm run fetch` to download the theme and verify it works via `pnpm run play`
4. Send in the PR!
6. Run `pnpm run fetch` to download the theme.
7. Run `pnpm run play` to start the playground. Select the new theme in the right column to verify the accuracy and confirm that the theme works as expected.
8. Send in the PR!

## License

The grammars included in this package are covered by their repositories’ respective licenses, which are permissive (apache-2.0, mit, etc), and made available in [Grammars NOTICE](./packages/tm-grammars/NOTICE) and [Themes NOTICE](./packages/tm-themes/NOTICE).
The grammars and themes included in this package are covered by their repositories’ respective licenses, which are permissive (apache-2.0, mit, etc), and made available in [Grammars NOTICE](./packages/tm-grammars/NOTICE) and [Themes NOTICE](./packages/tm-themes/NOTICE).

All other files [MIT](./LICENSE) © Pine Wu & Anthony Fu
All other files [MIT](./LICENSE) © Pine Wu & Anthony Fu.
Loading