docs: improve README for community use and contrib - #1
Draft
tomymaritano wants to merge 1 commit into
Draft
Conversation
Document what the plugin does, the dripnex/plugin-math install id, build/pack scripts, and a short contribution path. Co-authored-by: Tomás Maritano <tomymaritano@gmail.com>
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueThanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Expands
README.mdso people can use and contribute to this plugin without guessing.Covered, from the existing README, manifest, and source only:
math:insert) inserts a$$display-math fence at the cursor. KaTeX rendering ships with Dripnex.dripnex/plugin-mathnpm run buildandnpm run pack(frompackage.json)src/, build, open a focused PRNo feature claims beyond what the repo already documents. Draft only — please do not merge until reviewed.