refactor: update dependencies, switch to yarn and update the example

ph1p · Nov 29, 2018 · 282bd92 · 282bd92
1 parent 5a23951
commit 282bd92
Show file tree

Hide file tree

Showing 38 changed files with 13,115 additions and 18,550 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1 @@
-node_modules
+node_modules
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ This npm package is a command line script, which scans your JavaScript, Vue or T
 ## How to use?
 
 ```bash
-npm i vuepress-jsdoc -g
+yarn i vuepress-jsdoc -g
 ```
 
 **Example:**
@@ -95,19 +95,19 @@ The `./example` folder includes a full working vuepress-jsdoc example.
 
 ```bash
 # Install dependencies
-npm install
+yarn
 
 # Run the CLI
 vuepress-jsdoc
 
 # Generate docs
-npm run docs
+yarn run docs
 
 # Run dev server
-npm run dev
+yarn run dev
 
 # Generate dist folder
-npm run build
+yarn run build
 ```
 
 ## ToDo

diff --git a/example/README.md b/example/README.md
@@ -2,17 +2,17 @@
 
 ```bash
 # Install dependencies
-npm install
+yarn
 
 # Run the CLI
 vuepress-jsdoc
 
 # Generate docs
-npm run docs
+yarn run docs
 
 # Run dev server
-npm run dev
+yarn run dev
 
 # Generate dist folder
-npm run build
+yarn run build
 ```
diff --git a/example/documentation/.vuepress/config.js b/example/documentation/.vuepress/config.js
@@ -1,16 +1,17 @@
 const { sidebarTree } = require('../code/config');
 
-const config = {
+module.exports = {
+  contentLoading: true,
+  title: 'Hello vuepress-jsdoc',
+  description: 'Just playing around with vuepress-jsdoc',
   locales: {
     '/': {
       title: 'vuepress-jsdoc',
-      description: 'A JSDoc cli to build md files for static site generators'
+      description: 'A CLI to create jsdoc md files for vuepress'
     }
   },
   themeConfig: {
-    editLinks: true,
     sidebarDepth: 4,
-    docsDir: 'code',
     locales: {
       '/': {
         nav: [
@@ -27,5 +28,3 @@ const config = {
     }
   }
 };
-
-module.exports = config;
diff --git a/example/documentation/.vuepress/dist/404.html b/example/documentation/.vuepress/dist/404.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>vuepress-jsdoc</title>
+    <meta name="description" content="A JSDoc cli to build md files for static site generators">
+
+
+    <link rel="preload" href="/assets/css/0.styles.cc2a2ebf.css" as="style"><link rel="preload" href="/assets/js/app.149868c3.js" as="script"><link rel="prefetch" href="/assets/js/10.373a52df.js"><link rel="prefetch" href="/assets/js/11.a9bd2b99.js"><link rel="prefetch" href="/assets/js/12.4ab26e41.js"><link rel="prefetch" href="/assets/js/13.fd955fb4.js"><link rel="prefetch" href="/assets/js/2.30eef2e3.js"><link rel="prefetch" href="/assets/js/3.92bb1012.js"><link rel="prefetch" href="/assets/js/4.32c4ad07.js"><link rel="prefetch" href="/assets/js/5.29e1fac7.js"><link rel="prefetch" href="/assets/js/6.462fb79a.js"><link rel="prefetch" href="/assets/js/7.3882c9bb.js"><link rel="prefetch" href="/assets/js/8.b1f3e671.js"><link rel="prefetch" href="/assets/js/9.9626a376.js">
+    <link rel="stylesheet" href="/assets/css/0.styles.cc2a2ebf.css">
+  </head>
+  <body>
+    <div id="app" data-server-rendered="true"><div class="theme-container"><div class="content"><h1>404</h1> <blockquote>There's nothing here.</blockquote> <a href="/" class="router-link-active">Take me home.</a></div></div></div>
+    <script src="/assets/js/app.149868c3.js" defer></script>
+  </body>
+</html>
diff --git a/example/documentation/.vuepress/dist/assets/css/0.styles.cc2a2ebf.css b/example/documentation/.vuepress/dist/assets/css/0.styles.cc2a2ebf.css
diff --git a/example/documentation/.vuepress/dist/assets/img/search.83621669.svg b/example/documentation/.vuepress/dist/assets/img/search.83621669.svg
diff --git a/example/documentation/.vuepress/dist/assets/js/10.373a52df.js b/example/documentation/.vuepress/dist/assets/js/10.373a52df.js
diff --git a/example/documentation/.vuepress/dist/assets/js/11.a9bd2b99.js b/example/documentation/.vuepress/dist/assets/js/11.a9bd2b99.js
diff --git a/example/documentation/.vuepress/dist/assets/js/12.4ab26e41.js b/example/documentation/.vuepress/dist/assets/js/12.4ab26e41.js
diff --git a/example/documentation/.vuepress/dist/assets/js/13.fd955fb4.js b/example/documentation/.vuepress/dist/assets/js/13.fd955fb4.js
@@ -0,0 +1 @@
+(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{162:function(n,w,o){}}]);
diff --git a/example/documentation/.vuepress/dist/assets/js/2.30eef2e3.js b/example/documentation/.vuepress/dist/assets/js/2.30eef2e3.js
diff --git a/example/documentation/.vuepress/dist/assets/js/3.92bb1012.js b/example/documentation/.vuepress/dist/assets/js/3.92bb1012.js
diff --git a/example/documentation/.vuepress/dist/assets/js/4.32c4ad07.js b/example/documentation/.vuepress/dist/assets/js/4.32c4ad07.js
diff --git a/example/documentation/.vuepress/dist/assets/js/5.29e1fac7.js b/example/documentation/.vuepress/dist/assets/js/5.29e1fac7.js
diff --git a/example/documentation/.vuepress/dist/assets/js/6.462fb79a.js b/example/documentation/.vuepress/dist/assets/js/6.462fb79a.js
diff --git a/example/documentation/.vuepress/dist/assets/js/7.3882c9bb.js b/example/documentation/.vuepress/dist/assets/js/7.3882c9bb.js
diff --git a/example/documentation/.vuepress/dist/assets/js/8.b1f3e671.js b/example/documentation/.vuepress/dist/assets/js/8.b1f3e671.js