-
Notifications
You must be signed in to change notification settings - Fork 19
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
1 changed file
with
19 additions
and
104 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,125 +1,40 @@ | ||
|  | ||
| # Genie Framework documentation | ||
|
|
||
| # Nuxt UI Pro - Docs template | ||
| This site hosts the docs for all the packages in the Genie Framework. | ||
|
|
||
| [](https://ui.nuxt.com/pro) | ||
| [](https://nuxt.studio/themes/docs) | ||
|
|
||
| - [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) | ||
| # Running locally | ||
|
|
||
| ## Quick Start | ||
|
|
||
| ```bash [Terminal] | ||
| npx nuxi init -t github:nuxt-ui-pro/docs | ||
| ``` | ||
|
|
||
| ## Setup | ||
|
|
||
| Make sure to install the dependencies: | ||
| To run the site locally, execute | ||
|
|
||
| ```bash | ||
| # npm | ||
| npm install | ||
|
|
||
| # pnpm | ||
| pnpm install | ||
|
|
||
| # yarn | ||
| yarn install | ||
|
|
||
| # bun | ||
| 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 | ||
| # Deploying to production | ||
|
|
||
| Build the application for production: | ||
| On each commit to `main`, the site will be automatically deployed to learn.genieframework.com. When a pull request is created, a new preview site will be automatically linked in the comments. | ||
|
|
||
| ```bash | ||
| # npm | ||
| npm run build | ||
| # Adding content | ||
|
|
||
| # pnpm | ||
| pnpm run build | ||
| To add a new page, write its content into the `content/` folder in the relevant path. | ||
|
|
||
| # yarn | ||
| yarn build | ||
| # API docs | ||
|
|
||
| # bun | ||
| bun run build | ||
| ``` | ||
| The API docs each package's API section are built in [this repo](https://github.com/GenieFramework/APIDocs) | ||
|
|
||
| Locally preview production build: | ||
| # Code examples | ||
|
|
||
| ```bash | ||
| # npm | ||
| npm run preview | ||
|
|
||
| # pnpm | ||
| pnpm run preview | ||
|
|
||
| # yarn | ||
| yarn preview | ||
|
|
||
| # bun | ||
| bun run preview | ||
| ``` | ||
|
|
||
| Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. | ||
|
|
||
| ## Nuxt Studio integration | ||
|
|
||
| Add `@nuxthq/studio` dependency to your package.json: | ||
| The content in the Code Examples page is built in [this repo](https://github.com/BuiltWithGenie/CodeExamples). | ||
|
|
||
| ```bash | ||
| # 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`: | ||
|
|
||
| ```ts | ||
| export default defineNuxtConfig({ | ||
| ... | ||
| modules: [ | ||
| ... | ||
| '@nuxthq/studio' | ||
| ] | ||
| }) | ||
| ``` | ||
| # Contributing | ||
|
|
||
| Read more on [Nuxt Studio docs](https://nuxt.studio/docs/get-started/setup). | ||
| If you would like to contribute with a new article or fix mistakes, please open an issue with your suggested changes or open a new pull request. The team will review the text and make or request any necessary changes to make it fit better with the rest of the documentation. | ||
|
|
||
| ## Renovate integration | ||
| It is recommended that you ask first, either in an issue or on Discord, before contributing new materials to make sure they are a good fit. Here are some writing guidelines: | ||
|
|
||
| Install [Renovate GitHub app](https://github.com/apps/renovate/installations/select_target) on your repository and you are good to go. | ||
| - Be clear and concise: avoid jargon and complex sentences. Assume the reader is new to the topic. | ||
| - Consistent terminology: use consistent terms for the same concept throughout the documentation. | ||
| - Active voice: use the active voice as much as possible, e.g., "You can configure settings" rather than "Settings can be configured." | ||
| - Linking: provide links to relevant articles, guides, or documentation pages for further reading. |