Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: use docs nuxt layer #3

Merged
merged 7 commits into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .eslintignore

This file was deleted.

22 changes: 0 additions & 22 deletions .eslintrc.json

This file was deleted.

3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@
"strings": "off"
},
"editor.tabCompletion": "onlySnippets"
}
},
"eslint.experimental.useFlatConfig": true
}
135 changes: 36 additions & 99 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,125 +1,62 @@
![nuxt-ui-docs-social-card](https://github.com/nuxt-ui-pro/docs/assets/739984/f64e13d9-9ae0-4e03-bf7f-6be4c36cd9ba)
# Community Code

# Nuxt UI Pro - Docs template
Welcome to the ZKsync Community Code repository. This project serves as the community hub for ZKsync, providing comprehensive
documentation for developers written by developers.
Whether you're a beginner looking to get started with ZKsync or an experienced developer
seeking advanced guides, you'll find the resources you need here.

[![Nuxt UI Pro](https://img.shields.io/badge/Made%20with-Nuxt%20UI%20Pro-00DC82?logo=nuxt.js&labelColor=020420)](https://ui.nuxt.com/pro)
[![Nuxt Studio](https://img.shields.io/badge/Open%20in%20Nuxt%20Studio-18181B?&logo=nuxt.js&logoColor=3BB5EC)](https://nuxt.studio/themes/docs)
## Tools used

- [Live demo](https://docs-template.nuxt.dev/)
- [Play on Stackblitz](https://stackblitz.com/github/nuxt-ui-pro/docs)
- [Documentation](https://ui.nuxt.com/pro/getting-started)
- [Clone on Nuxt Studio](https://nuxt.studio/themes/docs)
- [Vue](https://vuejs.org/)
- [Nuxt](https://nuxt.com/)
- [Nuxt Content](https://content.nuxt.com/)
- [Nuxt UI & Nuxt UI Pro](https://ui.nuxt.com/)
- [Tailwind](https://tailwindcss.com/)
- [Bun](https://bun.sh/)

## Quick Start
## Local Setup

```bash [Terminal]
npx nuxi init -t github:nuxt-ui-pro/docs
```

## Setup

Make sure to install the dependencies:

```bash
# npm
npm install

# pnpm
pnpm install

# yarn
yarn install
This project uses bun to run, follow the [bun installation instructions](https://bun.sh/docs/installation). Once bun is
installed, run the following command to install all project dependencies:

# bun
```shell
bun install
```

## Development Server

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

```bash
# npm
npm run dev

# pnpm
pnpm run dev

# yarn
yarn dev

# bun
bun run dev
```

## Production

Build the application for production:

```bash
# npm
npm run build
## Development

# pnpm
pnpm run build
To run the project locally at `http://localhost:3000`

# yarn
yarn build

# bun
bun run build
```shell
bun run dev -o
```

Locally preview production build:

```bash
# npm
npm run preview

# pnpm
pnpm run preview
## Local Preview

# yarn
yarn preview
To locally preview the production build, first run `bun run generate` to build the project, then run the following:

# bun
```shell
bun run preview
```

Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
## Lint & Formatting

## Nuxt Studio integration
This project provides lint commands to check the project.

Add `@nuxthq/studio` dependency to your package.json:
### Markdown Linting

```bash
# npm
npm install --save-dev @nuxthq/studio
Markdown files are found in the `/content` directory. The following lint commands will run within that directory:

# 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`:

```ts
export default defineNuxtConfig({
...
modules: [
...
'@nuxthq/studio'
]
})
```shell
bun run lint:spelling
bun run lint:markdown
```

Read more on [Nuxt Studio docs](https://nuxt.studio/docs/projects/setup).
### Linting

## Renovate integration
The following commands are available to run linting on the project:

Install [Renovate GitHub app](https://github.com/apps/renovate/installations/select_target) on your repository and you are good to go.
```shell
bun run lint:prettier
bun run lint:eslint
```
85 changes: 6 additions & 79 deletions app.config.ts
Original file line number Diff line number Diff line change
@@ -1,95 +1,22 @@
export default defineAppConfig({
ui: {
variables: {
light: {
background: '255 252 255',
// foreground: '147 68 68',
},
dark: {
background: '17 20 43',
// foreground: 'var(--color-gray-200)',
},
// header: {
// height: '1rem',
// },
},
primary: 'zkPurple',
gray: 'zkSlate',
footer: {
bottom: {
left: 'text-sm text-gray-500 dark:text-gray-400',
wrapper: 'border-t border-gray-200 dark:border-gray-800',
},
},
content: {
prose: {
code: {
icon: {
go: 'vscode-icons:file-type-go',
vyper: 'devicon:vyper',
sol: 'vscode-icons:file-type-solidity',
},
},
},
},
},
seo: {
siteName: 'zkSync Community Cookbook',
siteName: 'ZKsync Community Code',
},
header: {
logo: {
alt: '',
light: '/logos/zksync_logo_black.svg',
dark: '/logos/zksync_logo.svg',
},
search: false,
colorMode: true,
links: [
{
icon: 'i-simple-icons-github',
to: 'https://github.com/matter-labs/zksync-docs',
target: '_blank',
'aria-label': 'zkSync Docs on GitHub',
title: 'zkSync Docs on GitHub',
},
],
},
footer: {
credits: 'Made with ❤️ by Matter Labs & Community',
colorMode: false,
links: [
{
icon: 'i-zksync-matterlabs-logo',
to: 'https://matter-labs.io',
target: '_blank',
'aria-label': 'MatterLabs Website',
},
{
icon: 'i-simple-icons-x',
to: 'https://x.com/zksync',
target: '_blank',
'aria-label': 'zkSync on X',
},
{
icon: 'i-simple-icons-github',
to: 'https://github.com/matter-labs',
target: '_blank',
'aria-label': 'zkSync on GitHub',
},
{
icon: 'i-simple-icons-discord',
to: 'https://join.zksync.dev/',
to: 'https://github.com/zkSync-Community-Hub/community-code',
target: '_blank',
'aria-label': 'zkSync on Discord',
'aria-label': 'Community Code on GitHub',
title: 'Community Code on GitHub',
},
],
},
toc: {
title: 'Table of Contents',
bottom: {
title: '',
edit: 'https://github.com/matter-labs/zksync-docs/edit/staging/content',
feedback: 'https://github.com/matter-labs/zksync-docs/issues/new?labels=documentation',
edit: 'https://github.com/zkSync-Community-Hub/community-code/edit/staging/content',
feedback: 'https://github.com/zkSync-Community-Hub/community-code/issues/new',
links: [],
},
},
Expand Down
11 changes: 6 additions & 5 deletions app.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
<script setup lang="ts">
import type { ParsedContent } from '@nuxt/content/dist/runtime/types';

provideHeadlessUseId(() => useId());
const { seo } = useAppConfig();

const { data: navigation } = await useAsyncData('navigation', () => fetchContentNavigation());
Expand Down Expand Up @@ -30,6 +29,7 @@ useSeoMeta({
titleTemplate: `%s - ${seo?.siteName}`,
ogSiteName: seo?.siteName,
ogUrl: 'https://docs.zksync.io/',
ogImage: '/social-card.png',
ogImageAlt: 'zkSync — Accelerating the mass adoption of crypto for personal sovereignty.',
ogDescription:
'zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and hyperchains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.',
Expand All @@ -40,7 +40,7 @@ useSeoMeta({
twitterImageAlt: 'zkSync — Accelerating the mass adoption of crypto for personal sovereignty.',
});

defineOgImage({ component: 'OgImageDocs' });
defineOgImage({ component: 'OgImageCommunityCode' });

provide('navigation', navigation);
</script>
Expand All @@ -49,15 +49,16 @@ provide('navigation', navigation);
<div>
<NuxtLoadingIndicator />

<AppHeader />
<HeaderComponent :links="[]" />

<UMain>
<NuxtLayout>
<NuxtPage />
</NuxtLayout>
</UMain>

<AppFooter />
<FooterComponent />

<UNotifications />
</div>
</template>
35 changes: 0 additions & 35 deletions assets/zksync-icons.ts

This file was deleted.

Binary file modified bun.lockb
Binary file not shown.
Loading
Loading