microsoft / microsoft/monaco-editor
[Feature Request] Monarch API documentation
Open
Nobody has claimed this yet.
feature-request
tokenization
- Dominant language
- JavaScript
- Stars
- 46.8k
- Forks
- 4.1k
- Avg merge
- 17h 58m
- Merged PRs (30d)
- 1
Description
Context
- This issue is not a bug report. (please use a different template for reporting a bug)
- This issue is not a duplicate of an existing issue. (please use the search to find existing issues)
Description
Would it be possible to add some documentation about Monarch's API to the docs page?
I'd like to use Monarch for syntax highlighting in a little project of mine, but the API seems undocumented, so a little hard to use.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Monarch documentation page at https://microsoft.github.io/monaco-editor/monarch.html and review what API information is currently missing. Identify the Monarch API surface that should be documented, then update that page so users can understand and use it; done means the page provides practical API documentation rather than only the existing overview.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100