tui-jsdoc-template - npm Package Compare versions

Comparing version 1.1.0 to 1.2.0

demo/jsdoc-conf.json

@@ -9,3 +9,6 @@ {
       "name": "Doc Template",
-      "footerText": "NHN Entertainment Frontend Development Lab"
+      "footerText": "NHN Entertainment Frontend Development Lab",
+      "logo": {
+        "link": "https://github.com/nhnent/tui.jsdoc-template"
+      }
   },
@@ -12,0 +15,0 @@ "opts": {

package.json

 {
   "name": "tui-jsdoc-template",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Toast UI JSDoc Template",
@@ -5,0 +5,0 @@ "main": "publish.js",

README.md

@@ -7,2 +7,3 @@ # TUI JSDoc Template
 ## install
+
 ```
@@ -13,16 +14,21 @@ npm i -D tui-jsdoc-template
 ## Feature
-TUI JSDoc template has following features.
 
-* Navigation - AutoComplete Searchbox
-* Navigation - Members / Methods / Events
-* Navigation - API / Examples(Tutorials) Tab
-* Navigation - Resize
-* Examples - HTML/JS source tab in example page
+TUI JSDoc template has the following features:
 
+* Navigation:
+  * AutoComplete Searchbox
+  * Collapsible
+  * Members / Methods / Events
+  * API / Examples (Tutorials) switcher
+  * Resizable
+* Examples: HTML/JS source tab in example pages
+
 ![Example](https://cloud.githubusercontent.com/assets/12269563/20049432/69d2ed42-a506-11e6-980e-53b991e5ee5b.png)
 
 ## Configuration
+
 ([*jsdoc page - configuration*](http://usejsdoc.org/about-configuring-jsdoc.html#incorporating-command-line-options-into-the-configuration-file))
 
 ### Template
+
 ```
@@ -34,3 +40,4 @@ "opts": {
 
-### Logo Image
+### Logo
+
 ```
@@ -41,3 +48,4 @@ "templates": {
         "width": "150px",
-        "height": "13px"
+        "height": "13px",
+        "link": "https://github.com/nhnent/tui.jsdoc-template"
     }
@@ -47,3 +55,4 @@ }
 
-### Page Title
+### Page title
+
 ```
@@ -55,6 +64,7 @@ "templates": {
 
-### FooterText
+### Footer text
+
 ```
 "templates": {
-    "footerText": "blabla..."
+    "footerText": "My awesome footer text"
 }
@@ -64,2 +74,3 @@ ```
 ### Use collapsible api list
+
 *Default: `true`*
@@ -73,2 +84,3 @@ ```
 ### Tab Names
+
 ```
@@ -86,2 +98,3 @@ "templates": {
 ### Custom Styles
+
 With a folder structure like this:
@@ -113,4 +126,4 @@ ```
 
-<br>
 ## Expose the html/js code to exmaple page
+
 If `script` or `div` elements have `code-js` or `code-html` class, expose their innerHTML.
@@ -142,5 +155,5 @@
 
-<br>
 ## Development
+
 1. Use `npm run serve` or `gulp serve` command to ascertain realtime.
 3. Api-Example tab, Auto-Complete and Resize functions are written in the `static/scripts/tui-doc.js` file.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

607139

increased by0.08%

Number of downloads

8570

increased by25.18%

Lines of code

2856

increased by0.11%

Number of lines in readme file

149

increased by9.56%

No dependency changes