mirror of
https://github.com/nuxt/nuxt.git
synced 2025-01-30 23:32:38 +00:00
doc: create/update README.mds for examples (#4980)
* Create README.md * Update README.md * Update README.md * Update README.md * Create README.md * Update README.md * Update README.md * Create README.md * Update README.md * Update README.md * Create README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Create README.md * Update Readme.md * Create README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Create README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Create README.md * Create README.md * Update README.md * Create README.md * Create README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Create README.md * Update README.md * Create README.md * Update README.md * Update README.md * Update README.md * Create README.md * Update README.md * Update examples/with-vuikit/README.md Co-Authored-By: husayt <husayt@gmail.com> * Update examples/auth-routes/README.md Co-Authored-By: husayt <husayt@gmail.com> * Update examples/middleware/README.md Co-Authored-By: husayt <husayt@gmail.com> * Update examples/vuex-store-modules/README.md Co-Authored-By: husayt <husayt@gmail.com> * Update examples/with-feathers/README.md Co-Authored-By: husayt <husayt@gmail.com> * Update examples/with-element-ui/README.md Co-Authored-By: husayt <husayt@gmail.com> * Update examples/with-cookies/README.md Co-Authored-By: husayt <husayt@gmail.com> * Update examples/vuex-store/README.md Co-Authored-By: husayt <husayt@gmail.com> * Update examples/vuex-persistedstate/README.md Co-Authored-By: husayt <husayt@gmail.com> * Update examples/with-firebase/README.md Co-Authored-By: husayt <husayt@gmail.com>
This commit is contained in:
parent
855705bd73
commit
c0311bc22f
3
examples/async-component-injection/README.md
Normal file
3
examples/async-component-injection/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Nuxt with advanced async components
|
||||
|
||||
See [here](https://vuejs.org/v2/guide/components.html#Advanced-Async-Components) for more details
|
@ -1,3 +1,3 @@
|
||||
# Authenticated Routes with Nuxt.js
|
||||
# Authenticated Routes with Nuxt and Express sessions
|
||||
|
||||
https://nuxtjs.org/examples/auth-routes
|
||||
|
@ -1,4 +1,10 @@
|
||||
# Axios Proxy Example
|
||||
# Nuxt with Axios Proxy Example
|
||||
|
||||
Using [proxy-module](https://github.com/nuxt-community/proxy-module) and [Axios module](https://axios.nuxtjs.org/)
|
||||
|
||||
> proxy-module is the one-liner node.js http-proxy middleware solution for Nuxt.js using [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware)
|
||||
|
||||
> Axios-module is a secure and easy [Axios](https://github.com/mzabriskie/axios) integration with Nuxt.js.
|
||||
|
||||
## Install
|
||||
|
||||
|
@ -1,3 +1,3 @@
|
||||
# Cached Components
|
||||
# Nuxt with Cached Components using lru-cache
|
||||
|
||||
https://nuxtjs.org/examples/cached-components
|
||||
|
@ -1,4 +1,4 @@
|
||||
# CoffeeScript
|
||||
# Nuxt with CoffeeScript
|
||||
|
||||
> Nuxt.js project with CoffeeScript
|
||||
|
||||
|
1
examples/custom-build/README.md
Normal file
1
examples/custom-build/README.md
Normal file
@ -0,0 +1 @@
|
||||
# Nuxt with customised build step
|
@ -1,3 +1,5 @@
|
||||
# Layouts
|
||||
# Nuxt layouts
|
||||
|
||||
https://nuxtjs.org/examples/layouts
|
||||
|
||||
Read more on Nuxt layouts [here](https://nuxtjs.org/guide/views#layouts)
|
||||
|
3
examples/custom-server/README.md
Normal file
3
examples/custom-server/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Nuxt with custom [Express](https://expressjs.com/) Server
|
||||
|
||||
> Express ia a fast, unopinionated, minimalist web framework for Node.js
|
@ -1,4 +1,4 @@
|
||||
# i18n with Nuxt.js
|
||||
# Nuxt with i18n
|
||||
|
||||
https://nuxtjs.org/examples/i18n
|
||||
|
||||
|
@ -1,4 +1,8 @@
|
||||
# Example how to test Nuxt.js app with Jest and Puppeteer
|
||||
# Nuxt with [Jest](https://jestjs.io/) and [Puppeteer](https://developers.google.com/web/tools/puppeteer/)
|
||||
|
||||
> Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
|
||||
|
||||
> Puppeteer is a Node library which provides a high-level API to control headless Chrome or Chromium over the DevTools Protocol.
|
||||
|
||||
# Install deps
|
||||
```
|
||||
@ -35,5 +39,5 @@ Ran all test suites.
|
||||
|
||||
## Documentation
|
||||
- [jest-puppeteer](https://github.com/smooth-code/jest-puppeteer)
|
||||
- [jest]()
|
||||
- [jest](https://jestjs.io/)
|
||||
- [puppeteer](https://pptr.dev/)
|
||||
|
@ -1,4 +1,8 @@
|
||||
# Jest + Vue Test Utils example
|
||||
# Nuxt with [Jest](https://jestjs.io/) and [Vue Test Utils](https://vue-test-utils.vuejs.org/)
|
||||
|
||||
> Vue Test Utils is the official unit testing utility library for Vue.js.
|
||||
|
||||
> Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
|
||||
|
||||
```sh
|
||||
# Install dependencies
|
||||
|
@ -1,5 +1,7 @@
|
||||
# Render Functions & JSX Example
|
||||
# Nuxt with render Functions & JSX Example
|
||||
|
||||
## Documentation
|
||||
|
||||
Vue: https://vuejs.org/v2/guide/render-function.html
|
||||
|
||||
Also see [TSX example](https://github.com/nuxt/nuxt.js/examples/typescript-tsx)
|
||||
|
@ -1,4 +1,4 @@
|
||||
# Markdown Example
|
||||
# Nuxt with Markdown
|
||||
|
||||
> Convert Markdown file to HTML using markdown-it.
|
||||
|
||||
|
@ -1,3 +1,6 @@
|
||||
# Middleware with Nuxt.js
|
||||
# Middleware with Nuxt
|
||||
|
||||
## Demo
|
||||
https://nuxtjs.org/examples/middleware
|
||||
|
||||
Read more Nuxt on middleware [here](https://nuxtjs.org/guide/routing#middleware)
|
||||
|
1
examples/named-views/README.md
Normal file
1
examples/named-views/README.md
Normal file
@ -0,0 +1 @@
|
||||
# Nuxt with named views
|
1
examples/nested-components/README.md
Normal file
1
examples/nested-components/README.md
Normal file
@ -0,0 +1 @@
|
||||
# Nuxt with nested components example
|
@ -1,4 +1,6 @@
|
||||
# PM2 with nuxt-ts example
|
||||
# Nuxt.ts with PM2 example
|
||||
|
||||
> [pm2](http://pm2.keymetrics.io/) ia an advanced process manager for production Node.js applications. Load balancer, logs facility, startup script, micro service management and more.
|
||||
|
||||
[Gracefull zero-downtime restart](https://pm2.io/doc/en/runtime/best-practices/graceful-shutdown/#graceful-start)
|
||||
|
||||
|
2
examples/spa/README.md
Normal file
2
examples/spa/README.md
Normal file
@ -0,0 +1,2 @@
|
||||
# Nuxt in SPA mode
|
||||
|
3
examples/static-images/README.md
Normal file
3
examples/static-images/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Nuxt with static images
|
||||
|
||||
How to use static images with nuxt
|
@ -1,3 +1,5 @@
|
||||
# styled-vue Example
|
||||
# Nuxt with [styled-vue](https://github.com/egoist/styled-vue)
|
||||
|
||||
> *styled-vue* allows to use dynamic styles in Vue single-file components.
|
||||
|
||||
See https://github.com/egoist/styled-vue
|
||||
|
@ -21,3 +21,7 @@ And since the CSS remains inline (due to using Purgecss as a postcss plugin) it
|
||||
|
||||
![pagespeed mobile](.github/pagespeed-mobile.png)
|
||||
![pagespeed desktop](.github/pagespeed-desktop.png)
|
||||
|
||||
### Other
|
||||
|
||||
See also this [demo](https://github.com/nuxt/nuxt.js/tree/dev/examples/with-purgecss)
|
||||
|
@ -1 +1 @@
|
||||
# TSX example
|
||||
# Nuxt with [TSX](https://www.typescriptlang.org/docs/handbook/jsx.html)
|
||||
|
@ -1,3 +1,3 @@
|
||||
# TypeScript with Vuex example
|
||||
# Nuxt with TypeScript and Vuex
|
||||
|
||||
https://nuxtjs.org/examples/typescript-vuex
|
||||
|
@ -1,3 +1,3 @@
|
||||
# TypeScript example
|
||||
# Nuxt with TypeScript example
|
||||
|
||||
https://codesandbox.io/s/0qmykr7wq0
|
||||
|
@ -1,6 +1,6 @@
|
||||
# UIKit with Nuxt.js
|
||||
# Nuxt with [UIKit](https://github.com/uikit/uikit)
|
||||
|
||||
UIkit: https://github.com/uikit/uikit
|
||||
> [UIkit](https://github.com/uikit/uikit) is a lightweight and modular front-end framework for developing fast and powerful web interfaces
|
||||
|
||||
Live demo: https://uikit.nuxtjs.org
|
||||
|
||||
|
@ -1,4 +1,6 @@
|
||||
# Vue-Apollo with Nuxt.js
|
||||
# Nuxt with [Vue-Apollo](https://vue-apollo.netlify.com/)
|
||||
|
||||
> *Vue-Apollo* is a Apollo/GraphQL integration for VueJS
|
||||
|
||||
Demo: https://nuxt-vue-apollo.now.sh/
|
||||
|
||||
|
@ -1,3 +1,6 @@
|
||||
# Vue-ChartJS with Nuxt.js
|
||||
# Nuxt with [Vue-ChartJS](https://vue-chartjs.org/)
|
||||
|
||||
> *Vue-chartjs* is a wrapper for [Chart.js](https://github.com/chartjs/Chart.js) in vue. You can easily create reuseable chart components.
|
||||
|
||||
|
||||
https://nuxtjs.org/examples
|
||||
|
3
examples/vue-class-component/README.md
Normal file
3
examples/vue-class-component/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Nuxt with [Vue-class-component](https://github.com/vuejs/vue-class-component) library
|
||||
|
||||
> *vue-class-component* is an ECMAScript / TypeScript decorator for class-style Vue components.
|
@ -1,3 +1,4 @@
|
||||
# Nuxt.js with Vuex persisted state (localStorage)
|
||||
# Nuxt with [Vuex](https://vuex.vuejs.org/) persisted state (localStorage)
|
||||
|
||||
See https://github.com/robinvdvleuten/vuex-persistedstate
|
||||
|
||||
Demo is using [vuex-persistedstate](https://github.com/robinvdvleuten/vuex-persistedstate) library
|
||||
|
@ -1,3 +1,7 @@
|
||||
# Nuxt.js with Vuex via File API
|
||||
# Nuxt with [Vuex](https://vuex.vuejs.org/) and store modules
|
||||
|
||||
> Vuex is a state management pattern + library for Vue.js applications.
|
||||
|
||||
Read on Vuex modules [here](https://vuex.vuejs.org/guide/modules.html)
|
||||
|
||||
https://nuxtjs.org/guide/vuex-store#modules-files
|
||||
|
@ -1,3 +1,7 @@
|
||||
# Nuxt.js with Vuex
|
||||
# Nuxt with [Vuex](https://vuex.vuejs.org/)
|
||||
|
||||
|
||||
>Vuex is a state management pattern + library for Vue.js applications.
|
||||
|
||||
|
||||
https://nuxtjs.org/examples/vuex-store
|
||||
|
@ -1,4 +1,4 @@
|
||||
# web-worker
|
||||
# Nuxt with web-workers using [Worker-loader](https://github.com/webpack-contrib/worker-loader)
|
||||
|
||||
> Nuxt.js project
|
||||
|
||||
|
3
examples/with-amp/README.md
Normal file
3
examples/with-amp/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Nuxt with [AMP](https://www.ampproject.org/)
|
||||
|
||||
>AMP is an open-source library that provides a straightforward way to create web pages that are compelling, smooth, and load near instantaneously for users. AMP pages are just web pages that you can link to and are controlled by you.
|
@ -1,3 +1,7 @@
|
||||
# Nuxt with [Ava](https://github.com/avajs/ava)
|
||||
|
||||
> AVA is a test runner for Node.js with a concise API, detailed error output, embrace of new language features and process isolation that let you write tests more effectively. So you can ship more awesome code. rocket
|
||||
|
||||
## Testing your Nuxt.js Application
|
||||
|
||||
https://nuxtjs.org/examples/testing
|
||||
|
3
examples/with-buefy/README.md
Normal file
3
examples/with-buefy/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Nuxt with [Buefy](https://buefy.github.io/)
|
||||
|
||||
> Buefy are lightweight UI components for Vue.js based on Bulma
|
@ -1,3 +1,5 @@
|
||||
# Hello World with Nuxt.js
|
||||
# Nuxt with cookies
|
||||
|
||||
This demo showcases reading/updating cookies with Nuxt.js
|
||||
|
||||
https://nuxtjs.org/examples
|
||||
|
3
examples/with-element-ui/README.md
Normal file
3
examples/with-element-ui/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Nuxt with [Element UI](https://element.eleme.io/#/en-US)
|
||||
|
||||
>Element, a Vue 2.0 based component library for developers, designers and product managers
|
@ -1,6 +1,4 @@
|
||||
# with-feathers
|
||||
|
||||
> Nuxt.js with Feathers
|
||||
# Nuxt with [Feathers](http://feathersjs.com)
|
||||
|
||||
## About
|
||||
|
||||
|
@ -1,6 +1,4 @@
|
||||
# nuxt-firebase
|
||||
|
||||
> Nuxt.js with Firebase (REST API)
|
||||
# Nuxt with [Firebase](https://firebase.google.com/) (REST API)
|
||||
|
||||
[DEMO](https://nuxt-firebase.now.sh/)
|
||||
|
||||
|
3
examples/with-museui/README.md
Normal file
3
examples/with-museui/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Nuxt with [Muse-UI](https://muse-ui.org/#/en-US/)
|
||||
|
||||
> Muse-UI is an elegant Material Design UI component library based on the Vue 2.0
|
@ -1,4 +1,6 @@
|
||||
# Nuxt.js with Purgecss (and Tailwind CSS)
|
||||
# Nuxt.js with [Purgecss](https://www.purgecss.com/) (and [Tailwind CSS](https://tailwindcss.com))
|
||||
|
||||
See https://www.purgecss.com
|
||||
> *Tailwind CSS* is a utility-first CSS framework for rapidly building custom user interfaces.
|
||||
|
||||
|
||||
> *Purgecss* is a tool to remove unused CSS. It can be used as part of your development workflow. Purgecss comes with a JavaScript API, a CLI, and plugins for popular build tools.
|
||||
|
@ -1,6 +1,9 @@
|
||||
# Nuxt.js with Socket.io
|
||||
# Nuxt with [Socket.io](https://socket.io/)
|
||||
|
||||
An example for Nuxt.js with WebSockets over Sockets.io.
|
||||
An example for Nuxt.js with WebSockets over Socket.io.
|
||||
|
||||
> Socket.IO enables real-time, bidirectional and event-based communication.
|
||||
> It works on every platform, browser or device, focusing equally on reliability and speed.
|
||||
|
||||
* Do you use Nuxt programmatically (eg. with Express or Koa)? Take a look into [`server.js`](./server.js) for setting up WS with your implementation
|
||||
|
||||
|
3
examples/with-tape/README.md
Normal file
3
examples/with-tape/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Nuxt with [Tape](https://github.com/substack/tape)
|
||||
|
||||
> Tape is a tap-producing test harness for node and browsers
|
@ -1,4 +1,6 @@
|
||||
# Nuxt With Vue-Material
|
||||
# Nuxt.js With [Vue-Material](https://vuematerial.io/)
|
||||
|
||||
> Vue Material is a Vue.js bassed Material Design component library
|
||||
|
||||
## Compatibility
|
||||
|
||||
|
@ -1,4 +1,6 @@
|
||||
# Using Vuetify.js with Nuxt.js
|
||||
# Using [Vuetify.js](https://vuetifyjs.com/en/) with Nuxt.js
|
||||
|
||||
> Vuetify is a Vue based Material Design Component Framework
|
||||
|
||||
## Demo
|
||||
https://nuxt-with-vuetify-example.surge.sh
|
||||
|
@ -1,3 +1,3 @@
|
||||
# Nuxt with Vuikit
|
||||
# Nuxt with [Vuikit](https://vuikit.js.org)
|
||||
|
||||
https://vuikit.js.org
|
||||
> Vuikit is a consistent and responsive Vue UI library, based on the front-end framework UIkit.
|
||||
|
3
examples/with-vux/README.md
Normal file
3
examples/with-vux/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Showcase of Nuxt.js and [VUX](https://github.com/airyland/vux)
|
||||
|
||||
> VUX is a Mobile UI Components based on Vue & WeUI.
|
Loading…
Reference in New Issue
Block a user