Merge pull request #595 from nisarhassan12/master
simplifies code contributions by fully automating the dev setup.
This commit is contained in:
10
.gitpod.yml
Normal file
10
.gitpod.yml
Normal file
@@ -0,0 +1,10 @@
|
||||
tasks:
|
||||
- init: yarn install
|
||||
command: yarn run start
|
||||
ports:
|
||||
- port: 3000
|
||||
onOpen: open-preview
|
||||
|
||||
vscode:
|
||||
extensions:
|
||||
- octref.vetur@0.23.0:0z6KpEz8h/vAvy4pYRDg3Q==
|
||||
14
README.md
14
README.md
@@ -3,6 +3,7 @@
|
||||
# tiptap
|
||||
A renderless and extendable rich-text editor for [Vue.js](https://github.com/vuejs/vue)
|
||||
|
||||
[](https://gitpod.io/#https://github.com/ueberdosis/tiptap)
|
||||
[](https://www.npmjs.com/package/tiptap)
|
||||
[](https://npmcharts.com/compare/tiptap?minimal=true)
|
||||
[](https://www.npmjs.com/package/tiptap)
|
||||
@@ -10,7 +11,6 @@ A renderless and extendable rich-text editor for [Vue.js](https://github.com/vue
|
||||
[](https://github.com/ueberdosis/tiptap/actions)
|
||||
[](https://github.com/sponsors/ueberdosis)
|
||||
|
||||
|
||||
## Why I built tiptap
|
||||
I was looking for a text editor for [Vue.js](https://github.com/vuejs/vue) and found some solutions that didn't really satisfy me. The editor should be easy to extend and not based on old dependencies such as jQuery. For React there is already a great editor called [Slate.js](https://github.com/ianstormtaylor/slate), which impresses with its modularity. I came across [Prosemirror](https://github.com/prosemirror) and decided to build on it. Prosemirror is a toolkit for building rich-text editors that are already in use at many well-known companies such as *Atlassian* or *New York Times*.
|
||||
|
||||
@@ -491,6 +491,18 @@ yarn build:packages
|
||||
yarn build:examples
|
||||
```
|
||||
|
||||
## Contribute using the online one-click setup
|
||||
|
||||
You can use Gitpod(a free online VS Code-like IDE) for contributing. With a single click, it will launch a workspace and automatically:
|
||||
|
||||
- clone the `tiptap` repo.
|
||||
- install the dependencies.
|
||||
- run `yarn run start`.
|
||||
|
||||
So that anyone interested in contributing can start straight away.
|
||||
|
||||
[](https://gitpod.io/#https://github.com/ueberdosis/tiptap/)
|
||||
|
||||
## Contributing
|
||||
|
||||
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
|
||||
|
||||
Reference in New Issue
Block a user