Git Product home page Git Product logo

vue-testpress's Introduction

vue-testpress

An experiment project on using testpress and vue-cli together.

Setup

vue create testpress
npx create-vuepress-site

Live edit support

Install

npm i -D vuepress-plugin-live acorn-dynamic-import

::: tip acorn-dynamic-import must be installed in order for vuepress-plugin-live to work :::

Config

// docs/.vuepress/config.js
module.exports = {
  plugins: [[["live"]]],
};

Usage

Register component

// docs/.vuepress/enhanceApp.js
export default ({ Vue }) => {
  Vue.component("HelloWorld", HelloWorld);
};

Reference the registered component

```vue live
<button>example</button>
```

TypeScript support

Install

npm i -D vuepress-plugin-typescript vuepress-types

Config

// docs/.vuepress/config.js
module.exports = {
  plugins: [
    [
      "vuepress-plugin-typescript",
      {
        tsLoaderOptions: {
          transpileOnly: true,
        },
      },
    ],
  ],
};

Publish to gitpages

npm run doc:build
git checkout gh-pages # git checkout -b gh-pages (first time)
rm docs -r
mv dist docs
git add docs
git commit -m "Rename dist to docs"
git push origin gh-pages

Resources

vue-testpress's People

Watchers

Tsz Lam avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.