Skip to content

Commit 08c8d2e

Browse files
committed
Initial commit
0 parents  commit 08c8d2e

17 files changed

+10443
-0
lines changed

.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
.DS_Store
3+
dist
4+
dist-ssr
5+
*.local
6+
*.zip

.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
16.15.1

.prettierrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"useTabs": false,
3+
"singleQuote": true,
4+
"trailingComma": "es5",
5+
"printWidth": 100
6+
}

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 Yoshihide Shiono
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# RemNote Plugin Template
2+
3+
## Required Software
4+
5+
You'll need the following software to start developing:
6+
7+
1. [Node.js](https://nodejs.org/en/download/)
8+
9+
2. [A GitHub Account](https://github.com/)
10+
11+
3. [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
12+
13+
4. An IDE or Text Editor
14+
15+
We recommend using [Visual Studio Code](https://code.visualstudio.com/), but any other IDE or text editor will work.
16+
17+
## Template Setup Guide
18+
19+
## Create a new repository from this template
20+
21+
- Above the file list, click the green button which says "Use this template".
22+
- Select the account you want to own the repository.
23+
- Type a name for your repository, and an optional description.
24+
- Choose a repository visibility.
25+
- Click "Create repository from template".
26+
27+
## Clone your new repository
28+
29+
- Browse to your new GitHub repository
30+
- Click on the Clone or download button
31+
- Press "HTTPS"
32+
- Copy the link
33+
- Open a terminal in the directory where you want to clone the repository
34+
- Run `git clone <link>` to download the repository.
35+
36+
### Running the Template
37+
38+
Open your terminal of choice and navigate into the folder of the repository you just cloned. If you are interested in learning about the structure of the plugin template, check the [plugin structure documentation](https://plugins.remnote.com/advanced/project_structure) page.
39+
40+
Then run:
41+
42+
```bash
43+
npm install
44+
```
45+
46+
This will install a very minimal React App, along with the RemNote plugin SDK (software development kit).
47+
48+
### Start your plugin
49+
50+
Inside the plugin folder, run:
51+
52+
```bash
53+
npm run dev-sandbox-only
54+
```
55+
56+
## Resources
57+
58+
If you are interested in building your own plugins, taking a look through the source code for our example plugins and plugins built by the community would be a great starting point.
59+
Of course, you should also check out the official documentation, guides and tutorials on our [plugin website](https://plugins.remnote.com).
60+
If you are new to writing plugins, we recommend checking out the [dictionary plugin project tutorial](https://plugins.remnote.com/in-depth-tutorial/overview).

0 commit comments

Comments
 (0)