-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
56 changed files
with
11,091 additions
and
1,351 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,59 +1,41 @@ | ||
![Hero](https://github.com/ZTL-UwU/shadcn-docs-nuxt/assets/49156174/b317288d-092d-4656-af5e-54034351daca) | ||
# HeyForm Help Center | ||
|
||
# shadcn-docs-nuxt | ||
## Setup | ||
|
||
[![built with nuxt][nuxt-src]][nuxt-href] | ||
[![npm version][npm-version-src]][npm-version-href] | ||
[![npm downloads][npm-downloads-src]][npm-downloads-href] | ||
[![License][license-src]][license-href] | ||
Make sure to install the dependencies: | ||
|
||
Beautifully designed _Nuxt Content_ template built with _shadcn-vue_. **Customizable. Compatible. Open Source.** | ||
```bash | ||
# yarn | ||
yarn install | ||
|
||
- [Documentation / Demo](https://shadcn-docs.nuxt.dev/) | ||
# npm | ||
npm install | ||
|
||
## Quick Start | ||
# pnpm | ||
pnpm install | ||
|
||
1. Create a project with the [starter template](https://github.com/ZTL-UwU/shadcn-docs-nuxt-starter) | ||
# bun | ||
bun install | ||
``` | ||
|
||
```bash | ||
npx nuxi@latest init -t github:ZTL-UwU/shadcn-docs-nuxt-starter | ||
``` | ||
## Development Server | ||
|
||
2. Install dependencies | ||
Start the development server on http://localhost:3000 | ||
|
||
```bash | ||
npm install | ||
``` | ||
```bash | ||
npm run dev | ||
``` | ||
|
||
3. Start dev server | ||
## Production | ||
|
||
```bash | ||
npm run dev | ||
``` | ||
Build the application for production: | ||
|
||
## Contributing | ||
```bash | ||
npm run build | ||
``` | ||
|
||
1. Clone this repository | ||
2. Install dependencies `bun install`. | ||
3. Use `bun run dev` to start dev server. | ||
Locally preview production build: | ||
|
||
## Credits | ||
|
||
- [Nuxt Content](https://content.nuxt.com/): Content made easy for Vue Developers. | ||
- [shadcn-ui](https://ui.shadcn.com/): For the beautiful component & docs design. | ||
- [shadcn-vue](https://www.shadcn-vue.com/): For the vue port of shadcn-ui & some docs component source. | ||
- [Docus](https://docus.dev/): For the inspiration & some docs component source. | ||
- [Nuxt UI Pro Docs](https://docs-template.nuxt.dev/): For the inspiration. | ||
|
||
## License | ||
|
||
MIT | ||
|
||
[npm-version-src]: https://img.shields.io/npm/v/shadcn-docs-nuxt?style=flat&colorA=18181b&colorB=18181b | ||
[npm-version-href]: https://npmjs.com/package/shadcn-docs-nuxt | ||
[npm-downloads-src]: https://img.shields.io/npm/dm/shadcn-docs-nuxt?style=flat&colorA=18181b&colorB=18181b | ||
[npm-downloads-href]: https://npmjs.com/package/shadcn-docs-nuxt | ||
[license-src]: https://img.shields.io/github/license/ZTL-UwU/shadcn-docs-nuxt.svg?style=flat&colorA=18181b&colorB=18181b | ||
[license-href]: https://github.com/ZTL-UwU/shadcn-docs-nuxt/blob/main/LICENSE | ||
[nuxt-src]: https://img.shields.io/badge/Built%20With%20Nuxt-18181B?logo=nuxt.js | ||
[nuxt-href]: https://nuxt.com/ | ||
```bash | ||
npm run preview | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.