star8ks / ao-cookbook-nuxt3

AO Cookbook nuxt3 version

ao Cookbook

The ao Cookbook is meant to house small digestible code snippets for someone that has no experience with ao to be able to grab and go.

Difference from official ao-cookbook

• Move top-level item to the top nav
  • reduce the length of left aside menu
  • Only show sub-level menu items in the current top-level menu
• For multiple languages, making a different branch to host this with different sub-domains will be better.
• Support doc search internal
• Use Nuxt3 Docs Template
• Require to buy a Nuxt3 UI Pro license to deploy, it's ok to dev in localhost without the licence key

Quick Start

git clone [email protected]:Web3HackerWorld/ao-cookbook-nuxt3.git

Setup

Make sure to install the dependencies:

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install

Development Server

Start the development server on http://localhost:3000:

# npm
npm run dev

# pnpm
pnpm run dev

# yarn
yarn dev

# bun
bun run dev

Production

Build the application for production:

# npm
npm run build

# pnpm
pnpm run build

# yarn
yarn build

# bun
bun run build

Locally preview production build:

# npm
npm run preview

# pnpm
pnpm run preview

# yarn
yarn preview

# bun
bun run preview

Check out the deployment documentation for more information.

Nuxt Studio integration

Add @nuxthq/studio dependency to your package.json:

# npm
npm install --save-dev @nuxthq/studio

# pnpm
pnpm add -D @nuxthq/studio

# yarn
yarn add -D @nuxthq/studio

# bun
bun add -d @nuxthq/studio

Add this module to your nuxt.config.ts:

export default defineNuxtConfig({
  ...
  modules: [
    ...
    '@nuxthq/studio'
  ]
})

Read more on Nuxt Studio docs.

Renovate integration

Install Renovate GitHub app on your repository and you are good to go.