friendlyuser / vuepress-theme-cool-starter

Starter project for vuepress theme cool

home	actionText	actionLink	features	footer
true	Get Started →	/custom-components/	title details Admonitions and Tables Uses google material icons and sortable tables title details Charts and Math Leverage chartjs and katex title details Diagramming tools Integrated with mermaid and plantuml	MIT Licensed | Copyright © 2020-present David Li

Disclaimer

As of [email protected] I cannot get this starter template running with vuepress installed globally, it throws an error message for me.

ReadMe

This is an example of how to use the vuepress-theme-cool vuepress theme, look into docs for example files.

Installation and Running

To install:

npm install

To run with vuepress installed locally:

npm install vuepress --save-dev

npm run docs:dev

Customization

Most of the customization is done in config.js, automatic navbar and sidebar navigation is available in config-other.js

Some other good vuepress examples can be found at vuepress-examples

If you would like to motivate me to spend more time improving open source projects please consider donating.

vuepress-theme-cool-starter's Issues

Update install instructions

Update the installation instructions to be less misleading and explain both choices.

See FriendlyUser/vuepress-theme-cool#18

@vuepress/back-to-top not working

how can it work on the back to top arrow?

Running build process fails

While I can run the dev server fine after cloning the repo, I see a failing build using node ./node_modules/vuepress/bin/vuepress.js build docs/

➜  vuepress-theme-cool-starter git:(master) ✗ node ./node_modules/vuepress/bin/vuepress.js build docs/

 WAIT  Extracting site metadata...
<badge class="warning">warning </badge>
<span class="badge badge-default">New</span>
<span class="badge error">ERROR</span>
[6:25:24 PM] Compiling Client
[6:25:24 PM] Compiling Server
(node:57169) DeprecationWarning: Tapable.plugin is deprecated. Use new API on `.hooks` instead
[6:25:33 PM] Compiled Server in 9s
[6:25:41 PM] Compiled Client in 17s
 WAIT  Rendering static HTML...
Rendering page: / FAIL  Error rendering /:
ReferenceError: document is not defined
    at Object.<anonymous> (/Users/powerjo/dev/scratch/vuepress-theme-cool-starter/node_modules/vue-good-table/dist/vue-good-table.cjs.js:2300:12)
    at Module._compile (internal/modules/cjs/loader.js:689:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
    at Module.load (internal/modules/cjs/loader.js:599:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
    at Function.Module._load (internal/modules/cjs/loader.js:530:3)
    at Module.require (internal/modules/cjs/loader.js:637:17)
    at require (internal/modules/cjs/helpers.js:20:18)
    at r (/Users/powerjo/dev/scratch/vuepress-theme-cool-starter/node_modules/vue-server-renderer/build.js:8335:16)
    at Object.<anonymous> (webpack:/external "vue-good-table":1:0)
    at __webpack_require__ (webpack/bootstrap:25:0)
    at Module.<anonymous> (server-bundle.js:24575:32)
    at __webpack_require__ (webpack/bootstrap:25:0)
    at Object.<anonymous> (server-bundle.js:37739:18)
    at __webpack_require__ (webpack/bootstrap:25:0)
    at server-bundle.js:118:18

Could you help me with that error, please?

Update vuepress package versions

When running this template with the latest vuepress plugins, it failed because they were versions 1.1.0, updating these plugins to 1.7.1 seems to have resolved the issue.

See FriendlyUser/vuepress-theme-cool#20

Is sidebar auto-generate?

I set the sidebar to true like config-other.js or set to an object like config.js
{ '/' : [ '', 'urs', 'server-req', 'change-logs' ] },
but it dose not show.

Thank you

clone 之后 运行报错

提示缺少vuepress

全局安装vuepress之后

非全局安装

安装下来的库并没有bin

Mindmap support

any mindmap diagram support?
I tried PlantUML Mindmap but no luck

Thank you for the nice theme.

Update Theme to Support Vuepress V1

Need to make corresponding updates to support V1 as described in FriendlyUser/vuepress-theme-cool#4