Add demo link to README

yuku · Dec 6, 2023 · ad5c2eb · ad5c2eb
1 parent 1d383d8
commit ad5c2eb
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -1,34 +1,33 @@
 # Textcomplete
 
-> Autocomplete for HTMLTextAreaElement and more.
+Autocomplete for HTMLTextAreaElement and more.
 
 ![Publish](https://github.com/yuku/textcomplete/workflows/Publish/badge.svg)
 ![Test](https://github.com/yuku/textcomplete/workflows/Test/badge.svg)
 ![GitHub pages](https://github.com/yuku/textcomplete/workflows/GitHub%20pages/badge.svg)
 
 ![](./docs/images/demo.gif)
 
-[Document](https://yuku.takahashi.coffee/textcomplete/).
+See more at [yuku.takahashi.coffee/textcomplete](https://yuku.takahashi.coffee/textcomplete/)
 
 ## Packages
 
 Textcomplete consists of subpackages:
 
-Name                          | Description
-------------------------------|-------------------------------------------
-@textcomplete/core            | Core of Textcomplete.
-@textcomplete/textarea        | Editor for HTMLTextAreaElement.
-@textcomplete/contenteditable | Editor for contenteditable. (Experimental)
-@textcomplete/codemirror      | Editor for CodeMirror. (Experimental)
-@textcomplete/utils           | Utility functions for editors.
+| Name                          | Description                                |
+|-------------------------------|--------------------------------------------|
+| @textcomplete/core            | Core of Textcomplete.                      |
+| @textcomplete/textarea        | Editor for HTMLTextAreaElement.            |
+| @textcomplete/contenteditable | Editor for contenteditable. (Experimental) |
+| @textcomplete/codemirror      | Editor for CodeMirror. (Experimental)      |
+| @textcomplete/utils           | Utility functions for editors.             |
 
 ## Development
 
-### View Document
+### View documentation
 
 ```bash
 yarn install
-yarn lerna bootstrap
 yarn docs
 ```
 

diff --git a/docs/sections/Editors.tsx b/docs/sections/Editors.tsx
@@ -62,7 +62,7 @@ export const Editors: FC<Props> = ({ id }) => (
       />
     </section>
     <section>
-      <h2>Contenteditable</h2>
+      <h2 id="textcomplete-contenteditable">Contenteditable</h2>
       <p>
         <code>@textcomplete/contenteditable</code> provides a textcomplete
         editor implementation for a contenteditable element. This package is

diff --git a/packages/textcomplete-codemirror/README.md b/packages/textcomplete-codemirror/README.md
@@ -1,9 +1,11 @@
 # @textcomplete/codemirror
 
-> Textcomplete editor for CodeMirror. (Experimental)
+Textcomplete editor for CodeMirror. (Experimental)
 
 [![npm version](https://badge.fury.io/js/@textcomplete%2Fcodemirror.svg)](http://badge.fury.io/js/@textcomplete%2Fcodemirror)
 
+Check the live demo [here](https://yuku.takahashi.coffee/textcomplete/#textcomplete-codemirror).
+
 ## Install
 
 ```bash

diff --git a/packages/textcomplete-contenteditable/README.md b/packages/textcomplete-contenteditable/README.md
@@ -1,9 +1,10 @@
 # @textcomplete/contenteditable
 
-> Textcomplete editor for contenteditable. (Experimental)
+Textcomplete editor for contenteditable. (Experimental)
 
 [![npm version](https://badge.fury.io/js/@textcomplete%2Fcontenteditable.svg)](http://badge.fury.io/js/@textcomplete%2Fcontenteditable)
 
+Check the live demo [here](https://yuku.takahashi.coffee/textcomplete/#textcomplete-contenteditable).
 
 ## Install
 

diff --git a/packages/textcomplete-core/README.md b/packages/textcomplete-core/README.md
@@ -1,9 +1,11 @@
 # @textcomplete/core
 
-> Core of Textcomplete
+Core of Textcomplete
 
 [![npm version](https://badge.fury.io/js/@textcomplete%2Fcore.svg)](http://badge.fury.io/js/@textcomplete%2Fcore)
 
+Read more and check the live demo at [yuku.takahashi.coffee/textcomplete](https://yuku.takahashi.coffee/textcomplete/)
+
 ## License
 
 &copy; Yuku Takahashi - This software is licensed under the MIT license.
diff --git a/packages/textcomplete-textarea/README.md b/packages/textcomplete-textarea/README.md
@@ -1,9 +1,11 @@
 # @textcomplete/textarea
 
-> Textcomplete editor for HTMLTextAreaElement.
+Textcomplete editor for HTMLTextAreaElement.
 
 [![npm version](https://badge.fury.io/js/@textcomplete%2Ftextarea.svg)](http://badge.fury.io/js/@textcomplete%2Ftextarea)
 
+Check the live demo [here](https://yuku.takahashi.coffee/textcomplete/#textcomplete-textarea).
+
 ## Install
 
 ```bash

diff --git a/packages/textcomplete-utils/README.md b/packages/textcomplete-utils/README.md
@@ -1,9 +1,11 @@
 # @textcomplete/utils
 
-> Utility functions for Textcomplete editors.
+Utility functions for Textcomplete editors.
 
 [![npm version](https://badge.fury.io/js/@textcomplete%2Futils.svg)](http://badge.fury.io/js/@textcomplete%2Futils)
 
+Read more at [yuku.takahashi.coffee/textcomplete](https://yuku.takahashi.coffee/textcomplete/)
+
 ## License
 
 &copy; Yuku Takahashi - This software is licensed under the MIT license.