Skip to content

Commit 5532d96

Browse files
deepakdebdeepakdeb
committed
first commit
0 parents  commit 5532d96

File tree

805 files changed

+86252
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

805 files changed

+86252
-0
lines changed

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ko_fi: ztl_uwu

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: 🐞 Bug report
2+
description: Create a report to help us improve
3+
labels: [🐞 bug]
4+
title: 'bug: '
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
This form is only for submitting bug reports. If you have a usage question
11+
or are unsure if this is really a bug, make sure to:
12+
13+
- Read the [docs](https://shadcn-docs-nuxt.vercel.app/)
14+
- Ask on [GitHub Discussions](https://github.com/ZTL-UwU/shadcn-docs-nuxt/discussions)
15+
- type: textarea
16+
id: bug-env
17+
attributes:
18+
label: Environment
19+
description: Output of `npx envinfo --system --npmPackages vue,@vueuse/core,shadcn-docs-nuxt,reka-ui,nuxt,shadcn-vue,shadcn-nuxt --binaries --browsers`
20+
placeholder: Environment
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: bug-description
25+
attributes:
26+
label: Describe the bug
27+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
28+
placeholder: Bug description
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: reproduction
33+
attributes:
34+
label: Reproduction
35+
description: A link to a repo that can reproduce the problem you ran into.
36+
placeholder: Reproduction
37+
- type: textarea
38+
id: additional
39+
attributes:
40+
label: Additional context
41+
description: If applicable, add any other context about the problem here
42+
- type: textarea
43+
id: logs
44+
attributes:
45+
label: Logs
46+
description: |
47+
Optional if provided reproduction. Please try not to insert an image but copy paste the log text.
48+
render: shell-script

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: 🚀 Feature request
2+
description: Suggest a feature that will improve shadcn-docs-nuxt
3+
labels: [✨ feature]
4+
title: 'feat: '
5+
body:
6+
- type: textarea
7+
id: feature-description
8+
attributes:
9+
label: Describe the feature
10+
description: A clear and concise description of what you think would be a helpful addition to shadcn-docs-nuxt, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link.
11+
placeholder: Feature description
12+
validations:
13+
required: true
14+
- type: checkboxes
15+
id: additional-info
16+
attributes:
17+
label: Additional information
18+
description: Additional information that helps us decide how to proceed.
19+
options:
20+
- label: Would you be willing to help implement this feature?

‎.github/workflows/ci.yml‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
pull_request:
9+
branches:
10+
- main
11+
12+
jobs:
13+
lint:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
18+
- name: Install pnpm
19+
uses: pnpm/action-setup@v4
20+
with:
21+
run_install: false
22+
23+
- uses: actions/setup-node@v4
24+
with:
25+
node-version: lts/*
26+
cache: pnpm
27+
28+
- name: Install dependencies
29+
run: pnpm install --frozen-lockfile
30+
31+
- name: Lint
32+
run: pnpm run lint
33+
34+
typecheck:
35+
runs-on: ubuntu-latest
36+
steps:
37+
- uses: actions/checkout@v4
38+
39+
- name: Install pnpm
40+
uses: pnpm/action-setup@v4
41+
with:
42+
run_install: false
43+
44+
- uses: actions/setup-node@v4
45+
with:
46+
node-version: lts/*
47+
cache: pnpm
48+
49+
- name: Install dependencies
50+
run: pnpm install --frozen-lockfile
51+
52+
- name: Typecheck
53+
run: pnpm run typecheck
54+
55+
build:
56+
strategy:
57+
fail-fast: false
58+
matrix:
59+
os: [ubuntu-latest, windows-latest, macos-latest]
60+
runs-on: ${{ matrix.os }}
61+
steps:
62+
- uses: actions/checkout@v4
63+
64+
- name: Install pnpm
65+
uses: pnpm/action-setup@v4
66+
with:
67+
run_install: false
68+
69+
- uses: actions/setup-node@v4
70+
with:
71+
node-version: lts/*
72+
cache: pnpm
73+
74+
- name: Install dependencies
75+
run: pnpm install --frozen-lockfile
76+
77+
- name: Build
78+
run: pnpm run build
79+
80+
generate:
81+
strategy:
82+
fail-fast: false
83+
matrix:
84+
os: [ubuntu-latest, windows-latest, macos-latest]
85+
runs-on: ${{ matrix.os }}
86+
steps:
87+
- uses: actions/checkout@v4
88+
89+
- name: Install pnpm
90+
uses: pnpm/action-setup@v4
91+
with:
92+
run_install: false
93+
94+
- uses: actions/setup-node@v4
95+
with:
96+
node-version: lts/*
97+
cache: pnpm
98+
99+
- name: Install dependencies
100+
run: pnpm install --frozen-lockfile
101+
102+
- name: Generate
103+
run: pnpm run generate

‎.github/workflows/pkg.pr.new.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Publish Any Commit
2+
on: [push, pull_request]
3+
4+
jobs:
5+
publish:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/checkout@v4
9+
10+
- name: Install pnpm
11+
uses: pnpm/action-setup@v4
12+
with:
13+
run_install: false
14+
15+
- uses: actions/setup-node@v4
16+
with:
17+
node-version: lts/*
18+
cache: pnpm
19+
20+
- name: Install dependencies
21+
run: pnpm install --frozen-lockfile
22+
23+
- run: pnpx pkg-pr-new publish

‎.gitignore‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Nuxt dev/build outputs
2+
.output
3+
.data
4+
.nuxt
5+
.nitro
6+
.cache
7+
dist
8+
9+
# Node dependencies
10+
node_modules
11+
12+
# Logs
13+
logs
14+
*.log
15+
16+
# Misc
17+
.DS_Store
18+
.fleet
19+
.idea
20+
21+
# Local env files
22+
.env
23+
.env.*
24+
!.env.example

‎.npmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shamefully-hoist=true

‎.vscode/settings.json‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{
2+
// Disable the default formatter, use eslint instead
3+
"prettier.enable": false,
4+
"editor.formatOnSave": false,
5+
6+
// Auto fix
7+
"editor.codeActionsOnSave": {
8+
"source.fixAll.eslint": "explicit",
9+
"source.organizeImports": "never"
10+
},
11+
12+
// Silent the stylistic rules in you IDE, but still auto fix them
13+
"eslint.rules.customizations": [
14+
{ "rule": "style/*", "severity": "off" },
15+
{ "rule": "format/*", "severity": "off" },
16+
{ "rule": "*-indent", "severity": "off" },
17+
{ "rule": "*-spacing", "severity": "off" },
18+
{ "rule": "*-spaces", "severity": "off" },
19+
{ "rule": "*-order", "severity": "off" },
20+
{ "rule": "*-dangle", "severity": "off" },
21+
{ "rule": "*-newline", "severity": "off" },
22+
{ "rule": "*quotes", "severity": "off" },
23+
{ "rule": "*semi", "severity": "off" }
24+
],
25+
26+
// Enable eslint for all supported languages
27+
"eslint.validate": [
28+
"javascript",
29+
"javascriptreact",
30+
"typescript",
31+
"typescriptreact",
32+
"vue",
33+
"html",
34+
"markdown",
35+
"json",
36+
"jsonc",
37+
"yaml",
38+
"toml",
39+
"xml",
40+
"gql",
41+
"graphql",
42+
"astro"
43+
],
44+
"editor.tabSize": 2,
45+
46+
"files.associations": {
47+
"*.css": "tailwindcss"
48+
},
49+
"editor.quickSuggestions": {
50+
"strings": "on"
51+
},
52+
53+
"mdc.enableComponentMetadataCompletions": true
54+
}

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Tony Zhang
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
![hero](https://github.com/user-attachments/assets/f954ed2a-c504-40c2-9e84-4ae4ed31e793)
2+
3+
# shadcn-docs-nuxt
4+
5+
[![built with nuxt][nuxt-src]][nuxt-href]
6+
[![npm version][npm-version-src]][npm-version-href]
7+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
8+
[![License][license-src]][license-href]
9+
[![sponsor][sponsor-src]][sponsor-href]
10+
11+
Beautifully designed _Nuxt Content_ template built with _shadcn-vue_. **Customizable. Compatible. Open Source.**
12+
13+
📖 [Documentation / Demo](https://shadcn-docs-nuxt.vercel.app/)
14+
15+
💬 [Discord](https://discord.gg/9P5HzAz8DT)
16+
17+
## Quick Start
18+
19+
1. Create a project with the [starter template](https://github.com/ZTL-UwU/shadcn-docs-nuxt-starter)
20+
21+
```bash
22+
npx nuxi@latest init -t github:ZTL-UwU/shadcn-docs-nuxt-starter
23+
```
24+
25+
2. Navigating to the Project Directory
26+
27+
```bash
28+
cd [project-name]
29+
```
30+
31+
3. Start dev server
32+
33+
```bash
34+
npm run dev
35+
```
36+
37+
## Contributing
38+
39+
1. Clone this repository.
40+
2. Install dependencies `pnpm install`.
41+
3. Use `pnpm run dev` to start dev server.
42+
4. Before committing, run `pnpm run lint:fix` and `pnpm run typecheck`.
43+
44+
## Credits
45+
46+
- [Nuxt Content](https://content.nuxt.com/): Content made easy for Vue Developers.
47+
- [shadcn-ui](https://ui.shadcn.com/): For the beautiful component & docs design.
48+
- [shadcn-vue](https://www.shadcn-vue.com/): For the vue port of shadcn-ui & some docs component source.
49+
- [Docus](https://docus.dev/): For the inspiration & some docs component source.
50+
- [Nuxt UI Pro Docs](https://docs-template.nuxt.dev/): For the inspiration.
51+
52+
## Who's Using
53+
54+
- [unovue/inspira-ui](https://github.com/unovue/inspira-ui) 3.1K ⭐️
55+
- [unjs/magic-regexp](https://github.com/unjs/magic-regexp) 4K ⭐️
56+
- [nuxt-monaco-editor](https://github.com/e-chan1007/nuxt-monaco-editor)
57+
- [nuxt-umami](https://github.com/ijkml/nuxt-umami)
58+
- [Msty](https://docs.msty.app/getting-started/onboarding)
59+
- [Archiver](https://github.com/Ast3risk-ops/archiver)
60+
- [ePoc](https://epoc.inria.fr/en)
61+
- [hexo-theme-solitude](https://github.com/everfu/hexo-theme-solitude) 1k ⭐️
62+
- [Add your project 🚀](https://github.com/ZTL-UwU/shadcn-docs-nuxt/edit/main/README.md)
63+
64+
## License
65+
66+
[MIT](https://github.com/ZTL-UwU/shadcn-docs-nuxt/blob/main/LICENSE)
67+
68+
---
69+
70+
<a href='https://ko-fi.com/T6T7R1M58' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi3.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
71+
72+
[npm-version-src]: https://img.shields.io/npm/v/shadcn-docs-nuxt?style=flat&colorA=18181b&colorB=18181b
73+
[npm-version-href]: https://npmjs.com/package/shadcn-docs-nuxt
74+
[npm-downloads-src]: https://img.shields.io/npm/dm/shadcn-docs-nuxt?style=flat&colorA=18181b&colorB=18181b
75+
[npm-downloads-href]: https://npm.chart.dev/shadcn-docs-nuxt?primary=neutral&gray=zinc&theme=light
76+
[license-src]: https://img.shields.io/github/license/ZTL-UwU/shadcn-docs-nuxt.svg?style=flat&colorA=18181b&colorB=18181b
77+
[license-href]: https://github.com/ZTL-UwU/shadcn-docs-nuxt/blob/main/LICENSE
78+
[nuxt-src]: https://img.shields.io/badge/Built%20With%20Nuxt-18181B?logo=nuxt
79+
[nuxt-href]: https://nuxt.com/
80+
[sponsor-src]: https://img.shields.io/badge/sponsor%20me-18181B?logo=kofi
81+
[sponsor-href]: https://ko-fi.com/ztl_uwu

0 commit comments

Comments
 (0)