Skip to content

Commit

Permalink
chore: update navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
dutterbutter committed Apr 2, 2024
1 parent fd75318 commit cf516c3
Show file tree
Hide file tree
Showing 11 changed files with 627 additions and 7 deletions.
2 changes: 0 additions & 2 deletions content/10.getting-started/_dir.yml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Deploy Smart Contracts on zkSync!
title: Smart Contracts
description: Learn to deploy smart contracts efficiently in the zkSync environment.
layout: test
---
Expand All @@ -21,10 +21,10 @@ Select the framework you want to get started using zkSync Era with.
---
items: [{
label: 'HardHat',
partial: '_getting-started/_hardhat_deploy_contract'
partial: '_quick-code/_hardhat_deploy_contract'
}, {
label: 'Foundry',
partial: '_getting-started/_foundry_deploy_contract'
partial: '_quick-code/_foundry_deploy_contract'
}]
---
::
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Installation
title: Contract Factories
description: Get started with Nuxt UI Pro documentation template.
layout: docs
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Usage
title: Testing
description: Learn how to write and customize your documentation.
---

Expand Down
155 changes: 155 additions & 0 deletions content/10.quick-code/4.upgrading.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
---
title: Upgradeability
description: Learn how to write and customize your documentation.
---

This is only a basic example of what you can achieve with [Nuxt UI Pro](https://ui.nuxt.com/pro/guide), you can tweak it
to match your needs. The template uses several Nuxt modules underneath like [`@nuxt/content`](https://content.nuxt.com)
for the content, [`@nuxtjs/fontaine`](https://github.com/nuxt-modules/fontaine) and
[`@nuxtjs/google-fonts`](https://github.com/nuxt-modules/google-fonts) to change the font and
[`nuxt-og-image`](https://nuxtseo.com/og-image/getting-started/installation) for social previews.

## ::callout

icon: i-heroicons-light-bulb target: \_blank to: [nuxt guide](https://ui.nuxt.com/pro/guide/usage#structure)

---

Learn more on how to customize and structure a Nuxt UI Pro app! ::

## Writing content

You can just start writing `.md` or `.yml` files in the [`content/`](https://content.nuxt.com/usage/content-directory)
directory to have your pages updated. The navigation will be automatically generated in the left aside and in the mobile
menu. You will also be able to go through your content with full-text search.

::callout{icon="i-heroicons-light-bulb"} This template relies on a
[catch-all route](https://nuxt.com/docs/guide/directory-structure/pages#catch-all-route) but you can achieve the same
thing with the [document-driven mode](https://content.nuxt.com/document-driven/introduction). ::

## App Configuration

In addition to `@nuxt/ui-pro` configuration through the `app.config.ts`, this template lets you customize the `Header`,
`Footer` and the `Table of contents` components.

### Header

```ts [app.config.ts]
export default defineAppConfig({
header: {
// Logo configuration
logo: {
// Light mode
light: {
src: '',
alt: '',
class: '',
},
// Dark mode
dark: {
src: '',
alt: '',
class: '',
},
},
// Show or hide the search bar
search: true,
// Show or hide the color mode button
colorMode: true,
// Customize links
links: [
{
icon: 'i-simple-icons-github',
to: 'https://github.com/nuxt-ui-pro/docs',
target: '_blank',
'aria-label': 'Docs template on GitHub',
},
],
},
});
```

### Footer

```ts [app.config.ts]
export default defineAppConfig({
footer: {
// Update bottom left credits
credits: 'Copyright © 2023',
// Show or hide the color mode button
colorMode: false,
// Customize links
links: [
{
icon: 'i-simple-icons-nuxtdotjs',
to: 'https://nuxt.com',
target: '_blank',
'aria-label': 'Nuxt Website',
},
{
icon: 'i-simple-icons-discord',
to: 'https://discord.com/invite/ps2h6QT',
target: '_blank',
'aria-label': 'Nuxt UI on Discord',
},
{
icon: 'i-simple-icons-x',
to: 'https://x.com/nuxt_js',
target: '_blank',
'aria-label': 'Nuxt on X',
},
{
icon: 'i-simple-icons-github',
to: 'https://github.com/nuxt/ui',
target: '_blank',
'aria-label': 'Nuxt UI on GitHub',
},
],
},
});
```

### Table of contents

```ts [app.config.ts]
export default defineAppConfig({
toc: {
// Title of the main table of contents
title: 'Table of Contents',
// Bottom TOC configuration
bottom: {
// Title of the bottom table of contents
title: 'Community',
// URL of your repository content folder
edit: '',
// Customize links
links: [
{
icon: 'i-heroicons-star',
label: 'Star on GitHub',
to: 'https://github.com/nuxt/ui',
target: '_blank',
},
{
icon: 'i-heroicons-book-open',
label: 'Nuxt UI Pro docs',
to: 'https://ui.nuxt.com/pro/guide',
target: '_blank',
},
{
icon: 'i-simple-icons-nuxtdotjs',
label: 'Purchase a license',
to: 'https://ui.nuxt.com/pro/purchase',
target: '_blank',
},
],
},
},
});
```

icon: i-heroicons-light-bulb target: \_blank to: [app-config](https://nuxt.studio/docs/developers/app-config)

---

A dedicated interface is provided to edit those configurations on Nuxt Studio. ::
155 changes: 155 additions & 0 deletions content/10.quick-code/5.verifying.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
---
title: Verifying
description: Learn how to write and customize your documentation.
---

This is only a basic example of what you can achieve with [Nuxt UI Pro](https://ui.nuxt.com/pro/guide), you can tweak it
to match your needs. The template uses several Nuxt modules underneath like [`@nuxt/content`](https://content.nuxt.com)
for the content, [`@nuxtjs/fontaine`](https://github.com/nuxt-modules/fontaine) and
[`@nuxtjs/google-fonts`](https://github.com/nuxt-modules/google-fonts) to change the font and
[`nuxt-og-image`](https://nuxtseo.com/og-image/getting-started/installation) for social previews.

## ::callout

icon: i-heroicons-light-bulb target: \_blank to: [nuxt guide](https://ui.nuxt.com/pro/guide/usage#structure)

---

Learn more on how to customize and structure a Nuxt UI Pro app! ::

## Writing content

You can just start writing `.md` or `.yml` files in the [`content/`](https://content.nuxt.com/usage/content-directory)
directory to have your pages updated. The navigation will be automatically generated in the left aside and in the mobile
menu. You will also be able to go through your content with full-text search.

::callout{icon="i-heroicons-light-bulb"} This template relies on a
[catch-all route](https://nuxt.com/docs/guide/directory-structure/pages#catch-all-route) but you can achieve the same
thing with the [document-driven mode](https://content.nuxt.com/document-driven/introduction). ::

## App Configuration

In addition to `@nuxt/ui-pro` configuration through the `app.config.ts`, this template lets you customize the `Header`,
`Footer` and the `Table of contents` components.

### Header

```ts [app.config.ts]
export default defineAppConfig({
header: {
// Logo configuration
logo: {
// Light mode
light: {
src: '',
alt: '',
class: '',
},
// Dark mode
dark: {
src: '',
alt: '',
class: '',
},
},
// Show or hide the search bar
search: true,
// Show or hide the color mode button
colorMode: true,
// Customize links
links: [
{
icon: 'i-simple-icons-github',
to: 'https://github.com/nuxt-ui-pro/docs',
target: '_blank',
'aria-label': 'Docs template on GitHub',
},
],
},
});
```

### Footer

```ts [app.config.ts]
export default defineAppConfig({
footer: {
// Update bottom left credits
credits: 'Copyright © 2023',
// Show or hide the color mode button
colorMode: false,
// Customize links
links: [
{
icon: 'i-simple-icons-nuxtdotjs',
to: 'https://nuxt.com',
target: '_blank',
'aria-label': 'Nuxt Website',
},
{
icon: 'i-simple-icons-discord',
to: 'https://discord.com/invite/ps2h6QT',
target: '_blank',
'aria-label': 'Nuxt UI on Discord',
},
{
icon: 'i-simple-icons-x',
to: 'https://x.com/nuxt_js',
target: '_blank',
'aria-label': 'Nuxt on X',
},
{
icon: 'i-simple-icons-github',
to: 'https://github.com/nuxt/ui',
target: '_blank',
'aria-label': 'Nuxt UI on GitHub',
},
],
},
});
```

### Table of contents

```ts [app.config.ts]
export default defineAppConfig({
toc: {
// Title of the main table of contents
title: 'Table of Contents',
// Bottom TOC configuration
bottom: {
// Title of the bottom table of contents
title: 'Community',
// URL of your repository content folder
edit: '',
// Customize links
links: [
{
icon: 'i-heroicons-star',
label: 'Star on GitHub',
to: 'https://github.com/nuxt/ui',
target: '_blank',
},
{
icon: 'i-heroicons-book-open',
label: 'Nuxt UI Pro docs',
to: 'https://ui.nuxt.com/pro/guide',
target: '_blank',
},
{
icon: 'i-simple-icons-nuxtdotjs',
label: 'Purchase a license',
to: 'https://ui.nuxt.com/pro/purchase',
target: '_blank',
},
],
},
},
});
```

icon: i-heroicons-light-bulb target: \_blank to: [app-config](https://nuxt.studio/docs/developers/app-config)

---

A dedicated interface is provided to edit those configurations on Nuxt Studio. ::
Loading

0 comments on commit cf516c3

Please sign in to comment.