Added getting-started.md

xdan · Jan 5, 2024 · eb14d72 · eb14d72
1 parent 937f126
commit eb14d72
Showing 1 changed file with 51 additions and 0 deletions.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -0,0 +1,51 @@
+# Getting Started
+
+via npm
+
+```shell
+npm install jodit
+```
+
+via yarn
+
+```shell
+yarn add jodit
+```
+
+cdnjs
+
+```html
+<link
+	rel="stylesheet"
+	href="https://cdnjs.cloudflare.com/ajax/libs/jodit/4.0.0-beta.24/es2021/jodit.min.css"
+/>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jodit/4.0.0-beta.24/es2021/jodit.min.js"></script>
+```
+
+unpkg
+
+```html
+<link
+	rel="stylesheet"
+	href="https://unpkg.com/jodit@4.0.0-beta.24/es2021/jodit.min.css"
+/>
+<script src="https://unpkg.com/jodit@4.0.0-beta.24/es2021/jodit.min.js"></script>
+```
+
+Self-hosted · Download files
+
+```html
+<link rel="stylesheet" href="build/es2021/jodit.min.css" />
+<script src="build/es2021/jodit.min.js"></script>
+```
+
+Usage
+
+```html
+<textarea id="editor"></textarea>
+<script>
+	const editor = Jodit.make('#editor', {
+		buttons: ['bold', 'italic', 'underline', '|', 'ul', 'ol']
+	});
+</script>
+```