Skip to content

Commit

Permalink
feat: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tiavina-mika committed Jun 19, 2024
1 parent 0aa3eb1 commit c790ff3
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
5 changes: 4 additions & 1 deletion .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
"version": "0.2",
"language": "en",
"words": [
"colord"
"octocat",
"automerge",
"tiptap",
"Tiptap"
],
"flagWords": [],
"ignorePaths": [
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To instead test a "built" version of this package which is installed into an "ex
When a new version should be cut since some new changes have landed on the `main` branch, do the following to publish it:

1. Go to the `main` branch and pull in the latest changes.
2. Commit change using (commit convention)[https://www.conventionalcommits.org/en/v1.0.0-beta.4/]
2. Commit change using (commit convention)[https://www.conventionalcommits.org]
3. Push the commit (ex: `git push origin main`)
4. The `release.yml` GitHub Actions workflow will auto-generate a tag, change log, release note and a PR branch
5. The `automerge.yml` GitHub Actions workflow will merge and delete the PR branch
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
- [Content with code](#content-with-code)
- [Customization](#customization)
- [Props](#props)
- [classNames Props](#classnames-props)
- [Types](#types)
- [Contributing](#contributing)

</details>
Expand Down Expand Up @@ -104,7 +104,7 @@ const html = `<p><h1>Hello there</h1></p>`;
|classNames|`ClassNameProps`|empty| class names of each element withing the container
|language|`string`|javascript| language of the code. [see the list](https://github.com/wooorm/lowlight?tab=readme-ov-file#data)

### classNames Props
## Types
|props |type | Default value | Description |
|----------------|-------------------------------|-----------------------------|-----------------------------|
|codeClassName|`string`|empty| class name of code element
Expand Down

0 comments on commit c790ff3

Please sign in to comment.