book-cli - npm Package Compare versions

Comparing version 1.0.0 to 1.2.0

package.json

 {
   "name": "book-cli",
-  "version": "1.0.0",
-  "description": "Init html book with markdown files.",
+  "version": "1.2.0",
+  "description": "Init a html book with markdown file.",
   "main": "index.js",
+  "directories": {
+    "doc": "docs"
+  },
+  "dependencies": {
+    "static-html-server": "^0.1.2"
+  },
+  "devDependencies": {},
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "server": "static-html-server -p 5000"
   },
@@ -15,5 +23,3 @@ "repository": {
     "book",
-    "github",
-    "markdown",
-    "html"
+    "markdown"
   ],
@@ -20,0 +26,0 @@ "author": "vvpvvp",

README.md

@@ -1,2 +0,46 @@
-# book-cli
-Init a html book with markdown file.
+# 介绍
+
+book-cli 是一个简单的静态页面系统，用于快速生成说明文档网站。
+
+简单来说，book-cli 不需要编译，你可以通过直接编写 `Markdown` 文件，达到文档网站的构建。
+
+## 文档说明
+
+[官网文档](https://vvpvvp.coding.me/book-cli/)
+
+
+## 优缺点
+
+### 优点
+
+* 快速入门
+* 无需编译
+* 快速部署（静态系统，随意扔在服务器上即可）
+* 自定义极强（纯静态系统，可以随意修改）
+* 适配PC端与移动端
+* 界面好看（脸皮较厚）
+
+
+### 缺点
+
+* 未编译成html，对于搜索引擎不友好（其实现在搜索引擎只需要收录下首页）
+* 无法全局搜索
+* 功能没有那么强大
+* 没有了~
+
+
+## Issue
+
+由于当前的版本刚刚发布，功能还不是很健全。
+
+如果遇到问题，请至github中提 [Issue](https://github.com/vvpvvp/book-cli/issues).
+
+## 谁在使用book-cli？
+
+* [ECMAScript 6](https://es6.ch-un.com/)
+
+如果你选择使用 book-cli 中，请联系我，将链接加入列表中。
+
+## 联系我
+
+作者：[vvpvvp](http://www.ch-un.com)

New alerts

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

447093

increased by26898.37%

Number of package files

29

increased by866.67%

Lines of code

1432

increased byInfinity%

Number of lines in readme file

46

increased by1433.33%

Worsened metrics

Dependency count

1

increased byInfinity%

Number of low quality alerts

2

increased by100%

Number of medium supply chain risk alerts

5

increased by400%

Dependency changes

• + Addedstatic-html-server@^0.1.2

• + Addedmime@1.2.11(transitive)

• + Addedminimist@0.2.4(transitive)

• + Addedstatic-html-server@0.1.2(transitive)