Skip to content

Commit 70b9eff

Browse files
committedOct 13, 2023
doc: Update README.md
1 parent 0d28d4b commit 70b9eff

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed
 

‎core/README.md

+26-2
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,31 @@ export interface Statistics {
538538
export declare const getStatistics: (view: ViewUpdate) => Statistics;
539539
```
540540

541-
### Related
541+
## Development
542+
543+
1. Install dependencies
544+
545+
```bash
546+
$ npm install # Installation dependencies
547+
$ npm run build # Compile all package
548+
```
549+
550+
2. Development `@uiw/react-codemirror` package:
551+
552+
```bash
553+
$ cd core
554+
# listen to the component compile and output the .js file
555+
# listen for compilation output type .d.ts file
556+
$ npm run watch # Monitor the compiled package `@uiw/react-codemirror`
557+
```
558+
559+
3. Launch documentation site
560+
561+
```bash
562+
npm run start
563+
```
564+
565+
## Related
542566

543567
- [@uiw/react-textarea-code-editor](https://github.com/uiwjs/react-textarea-code-editor): A simple code editor with syntax highlighting.
544568
- [@uiw/react-md-editor](https://github.com/uiwjs/react-md-editor): A simple markdown editor with preview, implemented with React.js and TypeScript.
@@ -555,7 +579,7 @@ As always, thanks to our amazing contributors!
555579
<img src="https://uiwjs.github.io/react-codemirror/CONTRIBUTORS.svg" />
556580
</a>
557581

558-
Made with [github-action-contributors](https://github.com/jaywcjlove/github-action-contributors).
582+
Made with [contributors](https://github.com/jaywcjlove/github-action-contributors).
559583

560584
## License
561585

0 commit comments

Comments
 (0)
Please sign in to comment.