docs: ✏️ md文档修改

LiZheGuang · LiZheGuang · commit 35e73297df95 · 2020-07-09T16:45:58.000+08:00
增加参数

BREAKING CHANGE: 🧨 无
diff --git a/README.md b/README.md
@@ -30,5 +30,24 @@ node index.js //指向骨架屏抓取
 
 ### 参数说明
 
-后期补充
+```
+ getSkeleton({
+    pageName: spliPageName(item.pageUrl), //文件名称
+    pageUrl: `${item.pageUrl}&role=puppeteer`, //生成路径
+    openRepeatList: true, //是否抓取的时候执行第个元素
+    device: "iPhone 6", // 为空则使用默认 PC 页面打开
+    minGrayBlockWidth: 20,  //最小宽度
+    minGrayPseudoWidth: 10, //伪类最小宽度
+    debug: false, //是否开启无头浏览器的debug模式
+    debugTime: 3000, // debug下停止的时间
+    filterClass: item.filterClass, //要过滤的标签
+    outputPath:'' //生成后的目录
+  });
+  
+```
+
+
+#### 再次说明
+
+此项目是基于awesome-skeleton 进行一些简单的源码修改，希望大家还是多多支持原作者。
 
diff --git a/demo/index.js b/demo/index.js
@@ -9,23 +9,23 @@ const spliPageName = (url) => {
 const skeletonObj = [
   {
     pageUrl:
-      "http://10.8.16.145:8080/parent-wx-h5Shop-shopShow.html?actId=5e796b01cce13f039dca4ee5",
+      "https://test.yangcong345.com/parent-wx-h5Shop-shopShow.html?actId=5e796b01cce13f039dca4ee5",
     filterClass: [],
   },
   {
     pageUrl:
-      "http://10.8.16.145:8080/parent-wx-h5Shop-list.html?id=5db95977947acb2e6d0c5a2d&fromtype=zheguangtestdddd&code=061qlt7j29zDpB0wE56j2HXe7j2qlt7j&state=parent",
+      "https://test.yangcong345.com/parent-wx-h5Shop-list.html?id=5db95977947acb2e6d0c5a2d&fromtype=zheguangtestdddd&code=061qlt7j29zDpB0wE56j2HXe7j2qlt7j&state=parent",
     filterClass: [],
   },
   {
     pageUrl:
-      "http://10.8.16.145:8080/parent-wx-h5Shop-my.html?id=5db95977947acb2e6d0c5a2d&fromtype=zheguangtestdddd",
+      "https://test.yangcong345.com/parent-wx-h5Shop-my.html?id=5db95977947acb2e6d0c5a2d&fromtype=zheguangtestdddd",
     filterClass: [],
   },
 
   {
     pageUrl:
-      "http://10.8.16.145:8080/parent-wx-h5Shop-orderList.html?id=5db95977947acb2e6d0c5a2d",
+      "https://test.yangcong345.com/parent-wx-h5Shop-orderList.html?id=5db95977947acb2e6d0c5a2d",
     filterClass: [],
   },
   {
@@ -50,7 +50,7 @@ skeletonObj.map((item) => {
     debug: false,
     debugTime: 3000,
     filterClass: item.filterClass,
-    // outputPath:'./ggname'//写入你要生成的目录在哪个项目里
+    outputPath:'/Users/lizheguang/GuangheCode/WX_H5/static/skeleton/'//写入你要生成的目录在哪个项目里
   });
 });
 
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "awesome-skeleton",
+  "name": "yc-skeleton",
   "version": "0.1.3",
   "description": "骨架图生成器",
   "author": "",
@@ -41,6 +41,6 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:kaola-fed/awesome-skeleton.git"
+    "url": "git@github.com:LiZheGuang/YC-skeleton.git"
   }
 }
diff --git a/src/index.js b/src/index.js
@@ -48,12 +48,12 @@ const getSkeleton = async function(options) {
   const skeletonImageBase64 = await saveScreenShot(page, options);
 
   // Inject the skeleton into the desired page
-  const result = insertSkeleton(skeletonImageBase64, options);
+  // const result = insertSkeleton(skeletonImageBase64, options);
 
   // Close the browser
   await browser.close();
 
-  return result;
+  // return result;
 };
 
 module.exports = getSkeleton;
diff --git a/src/insertSkeleton.js b/src/insertSkeleton.js
@@ -20,14 +20,14 @@ const insertSkeleton = (skeletonImageBase64, options) => {
     <html>
     <head>
     <style>
-      // @keyframes flush {
-      //   to {
-      //     opacity: 1;
-      // }
-      //   from {
-      //       opacity: .5;
-      //   }
-      // }
+      @keyframes flush {
+        to {
+          opacity: 1;
+      }
+        from {
+            opacity: .75;
+        }
+      }
     </style>
     </head>
     <body>

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "awesome-skeleton",`
	`2`	`+ "name": "yc-skeleton",`
`3`	`3`	`"version": "0.1.3",`
`4`	`4`	`"description": "骨架图生成器",`
`5`	`5`	`"author": "",`
`@@ -41,6 +41,6 @@`
`41`	`41`	`},`
`42`	`42`	`"repository": {`
`43`	`43`	`"type": "git",`
`44`		`- "url": "git@github.com:kaola-fed/awesome-skeleton.git"`
	`44`	`+ "url": "git@github.com:LiZheGuang/YC-skeleton.git"`
`45`	`45`	`}`
`46`	`46`	`}`