Skip to content

Commit

Permalink
Merge pull request #42 from wattanx/docs/fix-nuxt-bridge-migration
Browse files Browse the repository at this point in the history
docs: update nuxt bridge migration
  • Loading branch information
wattanx authored Jan 14, 2024
2 parents 2e39c48 + 8d72c07 commit f205e08
Show file tree
Hide file tree
Showing 4 changed files with 848 additions and 165 deletions.
7 changes: 4 additions & 3 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { defineConfig } from "vitepress";
import type { UserConfig, DefaultTheme } from "vitepress";

// https://vitepress.dev/reference/site-config
export default defineConfig({
export default {
title: "wattanx-converter",
description: "wattanx-converter provides useful tools for Vue and Nuxt.",
head: [
Expand Down Expand Up @@ -93,4 +93,5 @@ export default defineConfig({
{ icon: "github", link: "https://github.com/wattanx/wattanx-converter" },
],
},
});
cleanUrls: true,
} satisfies UserConfig<DefaultTheme.Config>;
19 changes: 16 additions & 3 deletions docs/cli/nuxt-bridge-migration-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,24 @@ title: Nuxt Bridge Migration Tools

A tool to support migration to Nuxt Bridge.

## Upgrade Steps

- [TypeScript](https://nuxt.com/docs/bridge/typescript)
- [Migrate Legacy Composition API](#migrate-legacy-composition-api)
- [docs](https://nuxt.com/docs/bridge/bridge-composition-api)
- [Plugins and Middleware](https://nuxt.com/docs/bridge/plugins-and-middleware)
- [Migrate New Composition API](#migrate-new-composition-api)
- [docs](https://nuxt.com/docs/bridge/nuxt3-compatible-api)
- [Meta Tags](https://nuxt.com/docs/bridge/meta)
- [Runtime Config](https://nuxt.com/docs/bridge/runtime-config)
- [Nitro](https://nuxt.com/docs/bridge/nitro)
- [Vite](https://nuxt.com/docs/bridge/vite)

## Usage

### Migrating from `@nuxtjs/composition-api` to `@nuxt/bridge` capi legacy
### Migrate Legacy Composition API

convert from `@nuxtjs/composition-api` to the capi legacy of `@nuxt/bridge`.
convert from `@nuxtjs/composition-api` to the legacy Composition API of `@nuxt/bridge`.

```bash
npx @wattanx/nuxt-bridge-migration@latest capi-legacy <files...>
Expand All @@ -29,7 +42,7 @@ const {

[useRoute migration](/cli/nuxt-bridge-migration-tools#useroute-migration)

### Migrating from `@nuxtjs/composition-api`
### Migrate New Composition API

Convert to nuxt 3 compatible composables in nuxt bridge.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"prettier": "latest",
"tailwindcss": "^3.2.4",
"turbo": "latest",
"vitepress": "1.0.0-alpha.75"
"vitepress": "1.0.0-rc.36"
},
"engines": {
"node": ">=14.0.0"
Expand Down
Loading

1 comment on commit f205e08

@vercel
Copy link

@vercel vercel bot commented on f205e08 Jan 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

wattanx-converter – ./

wattanx-converter-wattanx.vercel.app
wattanx-converter.vercel.app
wattanx-converter-git-main-wattanx.vercel.app

Please sign in to comment.