Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdehaven committed Dec 22, 2023
1 parent 14a2976 commit 51058e8
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Kong Markdown

> [!IMPORTANT]
> This repository and the `@kong/markdown` package are currently in development. Breaking changes should be expected.
> This repository and the `@kong/markdown` package are currently in development on the `alpha` branch. Breaking changes should be expected.
Kong's open-source markdown renderer and live editor.

Expand All @@ -19,13 +19,12 @@ Kong's open-source markdown renderer and live editor.

## TODO

- [ ] Utilize design tokens
- [ ] Add new icons for toolbar
- [ ] Possibly export a separate bundle as a web component utilizing [petite-vue](https://github.com/vuejs/petite-vue)
- [X] Utilize design tokens
- [X] Add new icons for toolbar
- [ ] Possibly export separate bundles for syntax highlighting options
- [ ] Document theming instructions
- [ ] Light / Dark mode
- [ ] Default `shikiji` theme(s)
- [ ] Supported languages (instead of allowing all)
- [ ] Default styles for markdown HTML elements

## Usage

Expand Down

0 comments on commit 51058e8

Please sign in to comment.