chore: fix tuidoc config info (#1576)

* chore: fix tuidoc config info

* chore: change main to master

* chore: build toastmark with rollup

* docs: add migration guide(en)

* docs: add widget tutorial(en)

* chore: remove prism js import in plugin readme

* docs: add extened autolinks(en)

* docs: add en tutorials

* chore: fix wrong type definition

* fix: remove viewet type def temporarily

.github/ISSUE_TEMPLATE/question.md

@@ -10,7 +10,7 @@ assignees: ''
  To make it easier for us to help you, please include as much useful information as possible.
 
  Useful Links:
- - tutorial: https://github.com/nhn/tui.editor/tree/main/docs
+ - tutorial: https://github.com/nhn/tui.editor/tree/master/docs
  - API/Example: https://nhn.github.io/tui.editor/latest/
 
  Before opening a new issue, please search existing issues https://github.com/nhn/tui.editor/issues

README.md

@@ -2,7 +2,7 @@
 
 > GFM Markdown and WYSIWYG Editor - Productive and Extensible
 
-[![github release version](https://img.shields.io/github/v/release/nhn/tui.editor.svg?include_prereleases)](https://github.com/nhn/tui.editor/releases/latest) [![npm version](https://img.shields.io/npm/v/@toast-ui/editor.svg)](https://www.npmjs.com/package/@toast-ui/editor) [![license](https://img.shields.io/github/license/nhn/tui.editor.svg)](https://github.com/nhn/tui.editor/blob/main/LICENSE) [![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg)](https://github.com/nhn/tui.editor/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) [![code with hearth by NHN](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-NHN-ff1414.svg)](https://github.com/nhn)
+[![github release version](https://img.shields.io/github/v/release/nhn/tui.editor.svg?include_prereleases)](https://github.com/nhn/tui.editor/releases/latest) [![npm version](https://img.shields.io/npm/v/@toast-ui/editor.svg)](https://www.npmjs.com/package/@toast-ui/editor) [![license](https://img.shields.io/github/license/nhn/tui.editor.svg)](https://github.com/nhn/tui.editor/blob/master/LICENSE) [![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg)](https://github.com/nhn/tui.editor/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) [![code with hearth by NHN](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-NHN-ff1414.svg)](https://github.com/nhn)
 
 <img src="https://user-images.githubusercontent.com/37766175/121809054-446bac80-cc96-11eb-9139-08c6d9ad2d88.png" />
 
@@ -27,24 +27,24 @@
 
 | Name | Description |
 | --- | --- |
-| [`@toast-ui/editor`](https://github.com/nhn/tui.editor/tree/main/apps/editor) | Plain JavaScript component |
+| [`@toast-ui/editor`](https://github.com/nhn/tui.editor/tree/master/apps/editor) | Plain JavaScript component |
 
 ### TOAST UI Editor's Wrappers
 
 | Name | Description |
 | --- | --- |
-| [`@toast-ui/react-editor`](https://github.com/nhn/tui.editor/tree/main/apps/react-editor) | [React](https://reactjs.org/) wrapper component |
-| [`@toast-ui/vue-editor`](https://github.com/nhn/tui.editor/tree/main/apps/vue-editor) | [Vue](https://vuejs.org/) wrapper component |
+| [`@toast-ui/react-editor`](https://github.com/nhn/tui.editor/tree/master/apps/react-editor) | [React](https://reactjs.org/) wrapper component |
+| [`@toast-ui/vue-editor`](https://github.com/nhn/tui.editor/tree/master/apps/vue-editor) | [Vue](https://vuejs.org/) wrapper component |
 
 ### TOAST UI Editor's Plugins
 
 | Name | Description |
 | --- | --- |
-| [`@toast-ui/editor-plugin-chart`](https://github.com/nhn/tui.editor/tree/main/plugins/chart) | Plugin to render chart |
-| [`@toast-ui/editor-plugin-code-syntax-highlight`](https://github.com/nhn/tui.editor/tree/main/plugins/code-syntax-highlight) | Plugin to highlight code syntax |
-| [`@toast-ui/editor-plugin-color-syntax`](https://github.com/nhn/tui.editor/tree/main/plugins/color-syntax) | Plugin to color editing text |
-| [`@toast-ui/editor-plugin-table-merged-cell`](https://github.com/nhn/tui.editor/tree/main/plugins/table-merged-cell) | Plugin to merge table columns |
-| [`@toast-ui/editor-plugin-uml`](https://github.com/nhn/tui.editor/tree/main/plugins/uml) | Plugin to render UML |
+| [`@toast-ui/editor-plugin-chart`](https://github.com/nhn/tui.editor/tree/master/plugins/chart) | Plugin to render chart |
+| [`@toast-ui/editor-plugin-code-syntax-highlight`](https://github.com/nhn/tui.editor/tree/master/plugins/code-syntax-highlight) | Plugin to highlight code syntax |
+| [`@toast-ui/editor-plugin-color-syntax`](https://github.com/nhn/tui.editor/tree/master/plugins/color-syntax) | Plugin to color editing text |
+| [`@toast-ui/editor-plugin-table-merged-cell`](https://github.com/nhn/tui.editor/tree/master/plugins/table-merged-cell) | Plugin to merge table columns |
+| [`@toast-ui/editor-plugin-uml`](https://github.com/nhn/tui.editor/tree/master/plugins/uml) | Plugin to render UML |
 
 
 ## 🤖 Why TOAST UI Editor?
@@ -86,20 +86,20 @@ CommonMark and GFM are great, but we often need more abstraction. The TOAST UI E
 
 **Five basic plugins** are provided as follows, and can be downloaded and used with npm.
 
-* [**`chart`**](https://github.com/nhn/tui.editor/tree/main/plugins/chart) : A code block marked as a 'chart' will render [TOAST UI Chart](https://github.com/nhn/tui.chart).
-* [**`code-syntax-highlight`**](https://github.com/nhn/tui.editor/tree/main/plugins/code-syntax-highlight) : Highlight the code block area corresponding to the language provided by [Prism.js](https://prismjs.com/).
-* [**`color-syntax`**](https://github.com/nhn/tui.editor/tree/main/plugins/color-syntax) : 
+* [**`chart`**](https://github.com/nhn/tui.editor/tree/master/plugins/chart) : A code block marked as a 'chart' will render [TOAST UI Chart](https://github.com/nhn/tui.chart).
+* [**`code-syntax-highlight`**](https://github.com/nhn/tui.editor/tree/master/plugins/code-syntax-highlight) : Highlight the code block area corresponding to the language provided by [Prism.js](https://prismjs.com/).
+* [**`color-syntax`**](https://github.com/nhn/tui.editor/tree/master/plugins/color-syntax) : 
 Using [TOAST UI ColorPicker](https://github.com/nhn/tui.color-picker), you can change the color of the editing text with the GUI.
-* [**`table-merged-cell`**](https://github.com/nhn/tui.editor/tree/main/plugins/table-merged-cell) : 
+* [**`table-merged-cell`**](https://github.com/nhn/tui.editor/tree/master/plugins/table-merged-cell) : 
 You can merge columns of the table header and body area.
-* [**`uml`**](https://github.com/nhn/tui.editor/tree/main/plugins/uml) : A code block marked as an 'uml' will render [UML diagrams](http:https://plantuml.com/screenshot).
+* [**`uml`**](https://github.com/nhn/tui.editor/tree/master/plugins/uml) : A code block marked as an 'uml' will render [UML diagrams](http:https://plantuml.com/screenshot).
 
 ## 🎨 Features
 
-* [Viewer](https://github.com/nhn/tui.editor/tree/main/docs/en/viewer.md) : Supports a mode to display only markdown data without an editing area.
-* [Internationalization (i18n)](https://github.com/nhn/tui.editor/tree/main/docs/en/i18n.md) : Supports English, Dutch, Korean, Japanese, Chinese, Spanish, German, Russian, French, Ukrainian, Turkish, Finnish, Czech, Arabic, Polish, Galician, Swedish, Italian, Norwegian, Croatian + language and you can extend.
-* [Widget](https://github.com/nhn/tui.editor/tree/main/docs/en/widget.md) : This feature allows you to configure the rules that replaces the string matching to a specific `RegExp` with the widget node.
-* [Custom Block](https://github.com/nhn/tui.editor/tree/main/docs/en/custom-block.md) : Nodes not supported by Markdown can be defined through custom block. You can display the node what you want through writing the parsing logic with custom block.
+* [Viewer](https://github.com/nhn/tui.editor/tree/master/docs/en/viewer.md) : Supports a mode to display only markdown data without an editing area.
+* [Internationalization (i18n)](https://github.com/nhn/tui.editor/tree/master/docs/en/i18n.md) : Supports English, Dutch, Korean, Japanese, Chinese, Spanish, German, Russian, French, Ukrainian, Turkish, Finnish, Czech, Arabic, Polish, Galician, Swedish, Italian, Norwegian, Croatian + language and you can extend.
+* [Widget](https://github.com/nhn/tui.editor/tree/master/docs/en/widget.md) : This feature allows you to configure the rules that replaces the string matching to a specific `RegExp` with the widget node.
+* [Custom Block](https://github.com/nhn/tui.editor/tree/master/docs/en/custom-block.md) : Nodes not supported by Markdown can be defined through custom block. You can display the node what you want through writing the parsing logic with custom block.
 
 ## 🐾 Examples
 
@@ -168,10 +168,10 @@ For more information, please refer to the Contributing section.
 
 ## 💬 Contributing
 
-* [Code of Conduct](https://github.com/nhn/tui.editor/blob/main/CODE_OF_CONDUCT.md)
-* [Contributing Guideline](https://github.com/nhn/tui.editor/blob/main/CONTRIBUTING.md)
-* [Commit Convention](https://github.com/nhn/tui.editor/blob/main/docs/COMMIT_MESSAGE_CONVENTION.md)
-* [Issue Guidelines](https://github.com/nhn/tui.editor/tree/main/.github/ISSUE_TEMPLATE)
+* [Code of Conduct](https://github.com/nhn/tui.editor/blob/master/CODE_OF_CONDUCT.md)
+* [Contributing Guideline](https://github.com/nhn/tui.editor/blob/master/CONTRIBUTING.md)
+* [Commit Convention](https://github.com/nhn/tui.editor/blob/master/docs/COMMIT_MESSAGE_CONVENTION.md)
+* [Issue Guidelines](https://github.com/nhn/tui.editor/tree/master/.github/ISSUE_TEMPLATE)
 
 
 ## 🍞 TOAST UI Family
@@ -191,4 +191,4 @@ For more information, please refer to the Contributing section.
 
 ## 📜 License
 
-This software is licensed under the [MIT](https://github.com/nhn/tui.editor/blob/main/LICENSE) © [NHN](https://github.com/nhn).
+This software is licensed under the [MIT](https://github.com/nhn/tui.editor/blob/master/LICENSE) © [NHN](https://github.com/nhn).

apps/editor/README.md

@@ -27,11 +27,11 @@ const editor = new Editor(options);
 
 ## 📙 Documents
 
-- [Getting Started](https://github.com/nhn/tui.editor/blob/main/docs/en/getting-started.md)
+- [Getting Started](https://github.com/nhn/tui.editor/blob/master/docs/en/getting-started.md)
 - [APIs](https://nhn.github.io/tui.editor/latest/)
 - v3.0 Migration Guide
- - [English](https://github.com/nhn/tui.editor/blob/main/docs/v3.0-migration-guide.md)
- - [한국어](https://github.com/nhn/tui.editor/blob/main/docs/v3.0-migration-guide-ko.md)
+ - [English](https://github.com/nhn/tui.editor/blob/master/docs/v3.0-migration-guide.md)
+ - [한국어](https://github.com/nhn/tui.editor/blob/master/docs/v3.0-migration-guide-ko.md)
 
 You can also see the older versions of API page on the [releases page](https://github.com/nhn/tui.editor/releases).
 
@@ -171,6 +171,6 @@ Find out more options [here](https://nhn.github.io/tui.editor/latest/ToastUIEdit
 
 ## 🦄 Tutorials
 
-- [Viewer](https://github.com/nhn/tui.editor/blob/main/apps/editor/docs/viewer.md)
-- [Plugins](https://github.com/nhn/tui.editor/blob/main/apps/editor/docs/plugins.md)
-- [Internationalization (i18n)](https://github.com/nhn/tui.editor/blob/main/apps/editor/docs/i18n.md)
+- [Viewer](https://github.com/nhn/tui.editor/blob/master/apps/editor/docs/en/viewer.md)
+- [Plugins](https://github.com/nhn/tui.editor/blob/master/apps/editor/docs/en/plugins.md)
+- [Internationalization (i18n)](https://github.com/nhn/tui.editor/blob/master/apps/editor/docs/en/i18n.md)

apps/editor/examples/example01-editor-basic.html

@@ -16,7 +16,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/getting-started.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/getting-started.md"
  rel="noopener noreferrer" target="_blank"
  >here</a>
  </div>

apps/editor/examples/example02-editor-with-horizontal-preview.html

@@ -16,7 +16,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/getting-started.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/getting-started.md"
  rel="noopener noreferrer" target="_blank"
  >here</a>
  </div>

apps/editor/examples/example03-editor-with-wysiwyg-mode.html

@@ -16,7 +16,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/getting-started.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/getting-started.md"
  rel="noopener noreferrer" target="_blank"
  >here</a>.
  </div>

apps/editor/examples/example04-viewer.html

@@ -16,7 +16,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/viewer.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/viewer.md"
  rel="noopener noreferrer" target="_blank"
  >here</a>.
  </div>

apps/editor/examples/example05-viewer-using-editor-factory.html

@@ -16,7 +16,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/viewer.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/viewer.md"
  rel="noopener noreferrer" target="_blank"
  >here</a
  >.

apps/editor/examples/example07-editor-with-chart-plugin.html

@@ -18,7 +18,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/plugins.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/plugins.md"
  rel="noopener noreferrer" target="_blank"
  >here</a
  >.

apps/editor/examples/example08-editor-with-code-syntax-highlight-plugin.html

@@ -26,7 +26,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/plugins.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/plugins.md"
  rel="noopener noreferrer" target="_blank"
  >here</a
  >.

apps/editor/examples/example09-editor-with-color-syntax-plugin.html

@@ -25,7 +25,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/plugins.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/plugins.md"
  rel="noopener noreferrer"
  target="_blank"
  >here</a

apps/editor/examples/example10-editor-with-table-merged-cell-plugin.html

@@ -17,7 +17,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/plugins.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/plugins.md"
  rel="noopener noreferrer"
  target="_blank"
  >here</a

apps/editor/examples/example11-editor-with-uml-plugin.html

@@ -16,7 +16,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/plugins.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/plugins.md"
  rel="noopener noreferrer" target="_blank"
  >here</a
  >.

apps/editor/examples/example12-editor-with-all-plugins.html

@@ -38,7 +38,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/plugins.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/plugins.md"
  rel="noopener noreferrer"
  target="_blank"
  >here</a

apps/editor/examples/example13-creating-plugin.html

@@ -22,12 +22,12 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/plugins.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/plugins.md"
  rel="noopener noreferrer" target="_blank"
  >here</a
  > and 
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/custom-block.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/custom-block.md"
  rel="noopener noreferrer" target="_blank"
  >here</a
  >.

apps/editor/examples/example15-customizing-toolbar-buttons.html

@@ -66,7 +66,7 @@
  ]
  });
 
- editor.getDefaultUI().insertToolbarItem({ groupIndex: 0, itemIndex: 0 }, {
+ editor.insertToolbarItem({ groupIndex: 0, itemIndex: 0 }, {
  name: 'myItem',
  tooltip: 'Custom Button',
  command: 'bold',

apps/editor/examples/example16-i18n.html

@@ -16,7 +16,7 @@
  <br />
  You can see the tutorial
  <a
- href="https://github.com/nhn/tui.editor/blob/main/docs/en/i18n.md"
+ href="https://github.com/nhn/tui.editor/blob/master/docs/en/i18n.md"
  rel="noopener noreferrer" target="_blank"
  >here</a
  >.

apps/editor/package.json

@@ -21,8 +21,15 @@
  "require": "./dist/toastui-editor.js"
  },
  "./viewer": {
- "import": "./dist/esm/indexViewer.js"
- }
+ "import": "./dist/esm/indexViewer.js",
+ "require": "./dist/toastui-editor-viewer.js"
+ },
+ "./dist/toastui-editor.css": "./dist/toastui-editor.css",
+ "./dist/toastui-editor-viewer.css": "./dist/toastui-editor-viewer.css",
+ "./dist/theme/toastui-editor-dark.css": "./dist/theme/toastui-editor-dark.css",
+ "./toastui-editor.css": "./dist/toastui-editor.css",
+ "./toastui-editor-viewer.css": "./dist/toastui-editor-viewer.css",
+ "./toastui-editor-dark.css": "./dist/theme/toastui-editor-dark.css"
  },
  "types": "types/index.d.ts",
  "files": [
@@ -56,8 +63,9 @@
  "build": "npm run build:esm && npm run build:i18n && npm run build:prod",
  "build:esm": "rollup -c",
  "note": "tui-note --tag=$(git describe --tags)",
- "doc:serve": "tuidoc --serv",
- "doc": "tuidoc"
+ "ts2js": "tsc --outDir tmpdoc --sourceMap false --target ES2015 --noEmit false",
+ "doc:dev": "npm run ts2js && tuidoc --serv",
+ "doc": "npm run ts2js && tuidoc"
  },
  "devDependencies": {
  "@toast-ui/release-notes": "^2.0.1",

apps/editor/src/editor.ts

@@ -1,12 +1,16 @@
 import { EditorOptions, ViewerOptions } from '@t/editor';
-import { DefaultUI, VNode } from '@t/ui';
+import { DefaultUI, VNode, IndexList, ToolbarItemOptions } from '@t/ui';
 import EditorCore from './editorCore';
 import Viewer from './viewer';
 import html from './ui/vdom/template';
 import { Layout } from './ui/components/layout';
 import { render } from './ui/vdom/renderer';
 
-class Editor extends EditorCore {
+/**
+ * ToastUI Editor
+ * @extends ToastUIEditorCore
+ */
+class ToastUIEditor extends EditorCore {
  private defaultUI!: DefaultUI;
 
  constructor(options: EditorOptions) {
@@ -44,18 +48,39 @@ class Editor extends EditorCore {
  });
  }
 
+ /**
+ * Factory method for Editor
+ * @param {object} options Option for initialize TUIEditor
+ * @returns {object} ToastUIEditor or ToastUIEditorViewer
+ */
  static factory(options: (EditorOptions | ViewerOptions) & { viewer?: boolean }) {
- return options.viewer ? new Viewer(options) : new Editor(options as EditorOptions);
+ return options.viewer ? new Viewer(options) : new ToastUIEditor(options as EditorOptions);
  }
 
- getDefaultUI() {
- return this.defaultUI;
+ /**
+ * add toolbar item
+ * @param {Object} indexInfo group index and item index of the toolbar item
+ * @param {string|Object} item toolbar item
+ */
+ insertToolbarItem(indexInfo: IndexList, item: string | ToolbarItemOptions) {
+ this.defaultUI.insertToolbarItem(indexInfo, item);
  }
 
+ /**
+ * Remove toolbar item
+ * @param {string} itemName toolbar item name
+ */
+ removeToolbarItem(itemName: string) {
+ this.defaultUI.removeToolbarItem(itemName);
+ }
+
+ /**
+ * Destroy TUIEditor from document
+ */
  destroy() {
  super.destroy();
  this.defaultUI.destroy();
  }
 }
 
-export default Editor;
+export default ToastUIEditor;