Skip to content
Permalink
Browse files

Add extra README note where required (#462)

* add more information to relevant README files

* remove incorrect word
  • Loading branch information...
msweeneydev committed Aug 7, 2019
1 parent 0b2d065 commit f1d2a2d30ec0280501238727101712899d726ef6
Showing with 16 additions and 4 deletions.
  1. +3 −1 docz/README.md
  2. +1 −1 docz/doczrc.js
  3. +2 −0 hyperapp/README.md
  4. +2 −0 marko/README.md
  5. +3 −1 nuxtjs/README.md
  6. +2 −0 storybook/README.md
  7. +3 −1 vuepress/README.md
@@ -2,14 +2,16 @@

This directory is a brief example of a [Docz](https://www.docz.site/) site that can be deployed to ZEIT Now with zero configuration.

## How we created this example
## How we created this example

To get started with Docz on Now, you can use the [Now CLI](https://zeit.co/download) to initialize the project:

```shell
$ now init docz
```

> The only change made is to add `dest: '/public'` to the `doczrc.js` file.
## Deploying this Example

Once initialized, you can deploy the Docz example with just a single command:
@@ -1,4 +1,4 @@
export default {
dest: '/public',
public: '/pub'
}
};
@@ -10,6 +10,8 @@ To get started with HyperApp on Now, you can use the [Now CLI](https://zeit.co/d
$ now init hyperapp
```

> The only change made is to amend the `releaseTarget` to `"public"` in the `taskfile.js` file.
## Deploying this Example

Once initialized, you can deploy the HyperApp example with just a single command:
@@ -10,6 +10,8 @@ To get started with Marko.js on Now, you can use the [Marko CLI](https://github.
$ marko create my-project
```

> The only change made is to add `&& mv dist public` to the build script in the `package.json` file.
## Deploying this Example

Once initialized, you can deploy the Marko.js example with just a single command:
@@ -2,14 +2,16 @@

This directory is a brief example of a [Nuxt.js](https://nuxtjs.org) app that can be deployed to ZEIT Now with zero configuration.

## How we created this example
## How we created this example

To get started with Nuxt.js on Now, you can use the [Create-Nuxt-App CLI](https://www.npmjs.com/package/create-nuxt-app) to initialize the project:

```shell
$ npx create-nuxt-app my-app
```

> The only change made is to amend the build script in `package.json` to `"nuxt generate && mv dist public"`.
## Deploying this Example

Once initialized, you can deploy the Nuxt.js example with just a single command:
@@ -10,6 +10,8 @@ To get started with Storybook on Now, you can use the [Now CLI](https://zeit.co/
$ now init storybook
```

> The only change made is to amend the output directory to `"public"` in the build script.
## Deploying this Example

Once initialized, you can deploy the Storybook example with just a single command:
@@ -2,14 +2,16 @@

This directory is a brief example of a [VuePress](https://vuepress.vuejs.org/) app that can be deployed to ZEIT Now with zero configuration.

## How we created this example
## How we created this example

To get started with VuePress on Now, you can use the [Now CLI](https://zeit.co/download) to initialize the project:

```shell
$ now init vuepress
```

> The only change made is to add `&& mv docs/.vuepress/dist public` to the build script in the `package.json` file.
## Deploying this Example

Once initialized, you can deploy the VuePress example with just a single command:

1 comment on commit f1d2a2d

@now

This comment has been minimized.

Copy link

commented on f1d2a2d Aug 7, 2019

Please sign in to comment.
You can’t perform that action at this time.