diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 5b0a804..9d9579a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -3,8 +3,7 @@ name: Bug report about: Create a report to help us improve title: "[BUG]" labels: bug -assignees: '' - +assignees: "" --- **Describe the bug** @@ -12,6 +11,7 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' @@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. **Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] **Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] + +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index f455865..58eb152 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -3,8 +3,7 @@ name: Feature request about: Suggest an idea for this project title: "[FEATURE]" labels: enhancement -assignees: '' - +assignees: "" --- **Is your feature request related to a problem? Please describe.** diff --git a/.husky/pre-commit b/.husky/pre-commit index 3884174..271b629 100644 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -2,3 +2,4 @@ . "$(dirname -- "$0")/_/husky.sh" turbo lint +pnpm format diff --git a/CHANGELOG.md b/CHANGELOG.md index bb2619f..420e6f2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1 +1 @@ -# Change Log +# Change Log diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 6ed581d..c99e5d4 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the +- Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or +- The use of sexualized language or imagery, and sexual attention or advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities @@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an +standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within diff --git a/README.md b/README.md index b164cb9..3aff79e 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ **Myanmar Calendar** is a feature-rich calendar app that seamlessly combines the functionality of Gregorian and Myanmar calendars, catering to users who follow both systems. It supports multiple languages, including Myanmar, Mon, English, Tai, and Karen, ensuring a user-friendly experience for individuals from diverse linguistic backgrounds. + > We do provide npm package with the most curated interface for developers. Please > check [here](https://www.npmjs.com/package/burma-calendar). @@ -12,17 +13,17 @@ Tai, and Karen, ensuring a user-friendly experience for individuals from diverse - Support Gregorian and Myanmar Calendar - Support multiple languages - - Mon - - Tai - - Karen - - Burmese - - English + - Mon + - Tai + - Karen + - Burmese + - English - Displays Myanmar Day, Month, Year and Moon phase - Easy-to-use interface, similar to Google Calendar and macOS Calendar - SupportCross-platform - - MacOS - - Windows - - Linux (Debian based distros) + - MacOS + - Windows + - Linux (Debian based distros) ## Demo @@ -55,5 +56,3 @@ details. If you have any questions or feedback about the Myanmar Calendar software, please open issue at [here](https://github.com/cybermm/myanmar_calendar/issues). - - diff --git a/apps/docs/app.config.ts b/apps/docs/app.config.ts index 1781f1a..ceb48ee 100644 --- a/apps/docs/app.config.ts +++ b/apps/docs/app.config.ts @@ -1,38 +1,39 @@ export default defineAppConfig({ docus: { - title: 'Docus', - description: 'The best place to start your documentation.', - image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png', + title: "Docus", + description: "The best place to start your documentation.", + image: + "https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png", socials: { - twitter: 'nuxt_js', - github: 'nuxt-themes/docus', + twitter: "nuxt_js", + github: "nuxt-themes/docus", nuxt: { - label: 'Nuxt', - icon: 'simple-icons:nuxtdotjs', - href: 'https://nuxt.com' - } + label: "Nuxt", + icon: "simple-icons:nuxtdotjs", + href: "https://nuxt.com", + }, }, github: { - dir: '.starters/default/content', - branch: 'main', - repo: 'docus', - owner: 'nuxt-themes', - edit: true + dir: ".starters/default/content", + branch: "main", + repo: "docus", + owner: "nuxt-themes", + edit: true, }, aside: { level: 0, collapsed: false, - exclude: [] + exclude: [], }, main: { padded: true, - fluid: true + fluid: true, }, header: { logo: true, showLinkIcon: true, exclude: [], - fluid: true - } - } -}) + fluid: true, + }, + }, +}); diff --git a/apps/docs/content/0.index.md b/apps/docs/content/0.index.md index d909fd8..6040d37 100644 --- a/apps/docs/content/0.index.md +++ b/apps/docs/content/0.index.md @@ -8,14 +8,16 @@ main: :ellipsis{right=0px width=75% blur=150px} -::block-hero ---- +## ::block-hero + cta: - - Get started - - /introduction/getting-started -secondary: - - Open on GitHub → - - https://github.com/nuxt-themes/docus + +- Get started +- /introduction/getting-started + secondary: +- Open on GitHub → +- https://github.com/nuxt-themes/docus + --- #title @@ -25,26 +27,32 @@ The best place to start your documentation. Write pages in [Markdown](https://content.nuxtjs.org), use [Vue](https://vuejs.org) components and enjoy the power of [Nuxt](https://nuxt.com). #extra - ::list - - **+50 Components** ready to build rich pages - - **Docs** and **Page** layouts - - Start from a `README`, scale to a framework documentation - - Navigation and Table of Contents generation - - Fully configurable design system - - Leverages [**Typography**](https://typography.nuxt.space/) and [**Elements**](https://elements.nuxt.dev) - - Used on [Content Documentation](https://content.nuxtjs.org) +::list + +- **+50 Components** ready to build rich pages +- **Docs** and **Page** layouts +- Start from a `README`, scale to a framework documentation +- Navigation and Table of Contents generation +- Fully configurable design system +- Leverages [**Typography**](https://typography.nuxt.space/) and [**Elements**](https://elements.nuxt.dev) +- Used on [Content Documentation](https://content.nuxtjs.org) :: #support - ::terminal - --- - content: - - npx nuxi@latest init -t themes/docus - - cd docs - - npm install - - npm run dev - --- - :: +::terminal + +--- + +content: + +- npx nuxi@latest init -t themes/docus +- cd docs +- npm install +- npm run dev + +--- + +:: :: ::card-grid @@ -55,45 +63,45 @@ What's included :ellipsis{left=0px width=40rem top=10rem blur=140px} #default - ::card{icon=logos:nuxt-icon} - #title - Nuxt Architecture - #description - Harness the full power of [Nuxt 3](https://v3.nuxtjs.org) and its [modules](https://modules.nuxtjs.org) ecosystem. - :: +::card{icon=logos:nuxt-icon} +#title +Nuxt Architecture +#description +Harness the full power of [Nuxt 3](https://v3.nuxtjs.org) and its [modules](https://modules.nuxtjs.org) ecosystem. +:: - ::card{icon=IconNuxtStudio} - #title - Nuxt Studio ready - #description - Edit your theme content and appearance with live-preview within [Nuxt Studio](https://nuxt.studio). - :: +::card{icon=IconNuxtStudio} +#title +Nuxt Studio ready +#description +Edit your theme content and appearance with live-preview within [Nuxt Studio](https://nuxt.studio). +:: - ::card{icon=logos:vue} - #title - Vue Components - #description - Use built-in components (or your own!) inside your content. - :: +::card{icon=logos:vue} +#title +Vue Components +#description +Use built-in components (or your own!) inside your content. +:: - ::card{icon=simple-icons:markdown} - #title - Write Markdown - #description - Enjoy the ease and simplicity of Markdown and discover [MDC syntax](https://content.nuxtjs.org/guide/writing/mdc). - :: +::card{icon=simple-icons:markdown} +#title +Write Markdown +#description +Enjoy the ease and simplicity of Markdown and discover [MDC syntax](https://content.nuxtjs.org/guide/writing/mdc). +:: - ::card{icon=noto:rocket} - #title - Deploy anywhere - #description - Zero config on [Vercel](https://vercel.com) or [Netlify](https://netlify.com). Choose between static generation, on-demand rendering (Node) or edge-side rendering on [CloudFlare workers](https://workers.cloudflare.com). - :: +::card{icon=noto:rocket} +#title +Deploy anywhere +#description +Zero config on [Vercel](https://vercel.com) or [Netlify](https://netlify.com). Choose between static generation, on-demand rendering (Node) or edge-side rendering on [CloudFlare workers](https://workers.cloudflare.com). +:: - ::card{icon=noto:puzzle-piece} - #title - Extensible. - #description - Customize the whole design, or add components using slots - you can make Docus your own. - :: +::card{icon=noto:puzzle-piece} +#title +Extensible. +#description +Customize the whole design, or add components using slots - you can make Docus your own. +:: :: diff --git a/apps/docs/content/1.introduction/1.getting-started.md b/apps/docs/content/1.introduction/1.getting-started.md index 4c08c14..85e7f53 100644 --- a/apps/docs/content/1.introduction/1.getting-started.md +++ b/apps/docs/content/1.introduction/1.getting-started.md @@ -20,17 +20,17 @@ npx nuxi@latest init docs -t themes/docus ::code-group - ```bash [npm] - npm install - ``` +```bash [npm] +npm install +``` - ```bash [yarn] - yarn install - ``` +```bash [yarn] +yarn install +``` - ```bash [pnpm] - pnpm install --shamefully-hoist - ``` +```bash [pnpm] +pnpm install --shamefully-hoist +``` :: diff --git a/apps/docs/content/1.introduction/2.project-structure.md b/apps/docs/content/1.introduction/2.project-structure.md index 1446a52..33e0304 100644 --- a/apps/docs/content/1.introduction/2.project-structure.md +++ b/apps/docs/content/1.introduction/2.project-structure.md @@ -17,5 +17,4 @@ The `content/` directory is where you [write Markdown pages](/introduction/writi The `app.config.ts` is where you [configure Docus](/introduction/configuration) to fit your branding and design. - The `nuxt.config.ts` is your [Nuxt configuration](https://nuxt.com/docs/getting-started/configuration). diff --git a/apps/docs/content/1.introduction/4.configuration.md b/apps/docs/content/1.introduction/4.configuration.md index d7d8e1a..4b84779 100644 --- a/apps/docs/content/1.introduction/4.configuration.md +++ b/apps/docs/content/1.introduction/4.configuration.md @@ -7,30 +7,30 @@ Learn how to configure Docus. ```ts [Minimal app.config.ts] export default defineAppConfig({ docus: { - title: 'Docus', - description: 'My Docus Project', - url: 'http://docus.dev' - } -}) + title: "Docus", + description: "My Docus Project", + url: "http://docus.dev", + }, +}); ``` ```ts [Complete app.config.ts] export default defineAppConfig({ docus: { - title: 'Docus', - description: 'My Docus Project', - url: 'http://docus.dev', - image: '/social-card-preview.png', + title: "Docus", + description: "My Docus Project", + url: "http://docus.dev", + image: "/social-card-preview.png", socials: { - twitter: '@nuxt_js', - github: 'nuxt-themes/docus', + twitter: "@nuxt_js", + github: "nuxt-themes/docus", }, github: { - root: 'content', + root: "content", edit: true, - contributors: false + contributors: false, }, - layout: 'default', + layout: "default", aside: { level: 1, filter: [], @@ -38,37 +38,37 @@ export default defineAppConfig({ header: { title: false, logo: true, - showLinkIcon: false + showLinkIcon: false, }, footer: { credits: { - icon: 'IconDocus', - text: 'Powered by Docus', - href: 'https://docus.dev', + icon: "IconDocus", + text: "Powered by Docus", + href: "https://docus.dev", }, textLinks: [ { - text: 'Nuxt', - href: 'https://nuxt.com', - target: '_blank', - rel: 'noopener' - } + text: "Nuxt", + href: "https://nuxt.com", + target: "_blank", + rel: "noopener", + }, ], iconLinks: [ { - label: 'NuxtJS', - href: 'https://nuxtjs.org', - component: 'IconNuxtLabs', + label: "NuxtJS", + href: "https://nuxtjs.org", + component: "IconNuxtLabs", }, { - label: 'Vue Telescope', - href: 'https://vuetelescope.com', - component: 'IconVueTelescope', + label: "Vue Telescope", + href: "https://vuetelescope.com", + component: "IconVueTelescope", }, ], - } - } -}) + }, + }, +}); ``` :: @@ -132,9 +132,8 @@ export default defineAppConfig({ | `github.repo` | `string` | | Name of the GitHub repo to edit files | | `github.owner` | `string` | | Owner of the repo | | `github.edit` | `boolean` | | Toggle "Edit this page on Github" component on documentation pages | -**Search** |||| -| `fuse` | `object` || useFuse [options](https://vueuse.org/integrations/useFuse/) | - +| **Search** | | | | +| `fuse` | `object` | | useFuse [options](https://vueuse.org/integrations/useFuse/) | ## Customizing the logo @@ -144,6 +143,6 @@ In this example, the image is located at `/public/img`. ```vue [components/Logo.vue] ``` diff --git a/apps/docs/content/2.api/1.components.md b/apps/docs/content/2.api/1.components.md index 74b17d8..12bc937 100644 --- a/apps/docs/content/2.api/1.components.md +++ b/apps/docs/content/2.api/1.components.md @@ -2,15 +2,14 @@ Discover every component you can use in your content. - ## `` ::code-group - ::code-block{label="Preview" preview} - ::alert{type="info" style="margin-top: 0;"} - Check out an **info** alert with `code` and a [link](/). - :: +::code-block{label="Preview" preview} +::alert{type="info" style="margin-top: 0;"} +Check out an **info** alert with `code` and a [link](/). +:: ::alert{type="success"} Check out a **success** alert with `code` and a [link](/). @@ -23,37 +22,38 @@ Discover every component you can use in your content. ::alert{type="danger" style="margin-bottom: 0;"} Check out a **danger** alert with `code` and a [link](/). :: - :: - ```md [Code] - ::alert{type="info"} - Check out an **info** alert with `code` and a [link](/). - :: +:: - ::alert{type="success"} - Check out a **success** alert with `code` and a [link](/). - :: +```md [Code] +::alert{type="info"} +Check out an **info** alert with `code` and a [link](/). +:: - ::alert{type="warning"} - Check out a **warning** alert with `code` and a [link](/). - :: +::alert{type="success"} +Check out a **success** alert with `code` and a [link](/). +:: - ::alert{type="danger"} - Check out a **danger** alert with `code` and a [link](/). - :: - ``` +::alert{type="warning"} +Check out a **warning** alert with `code` and a [link](/). +:: + +::alert{type="danger"} +Check out a **danger** alert with `code` and a [link](/). +:: +``` :: - -::source-link ---- -source: "components/content/Alert.vue" ---- +## ::source-link + +## source: "components/content/Alert.vue" + :: --- @@ -64,9 +64,9 @@ source: "components/content/Alert.vue" ::code-group - ::code-block{label="Preview" preview} - ::div{style="display:flex; gap: 1rem;"} - :badge[v1.2] +::code-block{label="Preview" preview} +::div{style="display:flex; gap: 1rem;"} +:badge[v1.2] :badge[Deprecated]{type="warning"} @@ -74,29 +74,30 @@ source: "components/content/Alert.vue" Not found! :: :: - :: - ```md [Code] - :badge[v1.2] - - :badge[Deprecated]{type="warning"} - - ::badge{type="danger"} - Not found! - :: - ``` +:: + +```md [Code] +:badge[v1.2] + +:badge[Deprecated]{type="warning"} + +::badge{type="danger"} +Not found! +:: +``` :: - -::source-link ---- -source: "components/content/Badge.vue" ---- +## ::source-link + +## source: "components/content/Badge.vue" + :: --- @@ -105,81 +106,82 @@ source: "components/content/Badge.vue" ::code-group - ::code-block{label="Preview"} - ::block-hero - --- - cta: - - Get started - - /introduction/getting-started - secondary: - - Open on GitHub → - - https://github.com/nuxtlabs/docus - snippet: npx nuxi@latest init docus-app -t nuxtlabs/docus-starter - --- - #title - Document-driven framework - +::code-block{label="Preview"} +::block-hero +--- +cta: - Get started - /introduction/getting-started +secondary: - Open on GitHub → - https://github.com/nuxtlabs/docus +snippet: npx nuxi@latest init docus-app -t nuxtlabs/docus-starter +--- +#title +Document-driven framework + #description Docus reconciles content creators and developers by offering to both the best tools to create and scale content-based websites. :: - :: - - ```md [Code] - ::block-hero - --- - cta: - - Get started - - /get-started - secondary: - - Open on GitHub → - - https://github.com/nuxtlabs/docus - snippet: npx nuxi@latest init docus-app -t nuxtlabs/docus-starter - --- - #title - Document-driven framework - - #description - Docus reconciles content creators and developers by offering to both the best tools to create and scale content-based websites. - :: - ``` - -:: - - -::source-link ---- -source: "components/content/BlockHero.vue" ---- +## ::source-link + +## source: "components/content/BlockHero.vue" + :: --- ## `` + ::code-group - ::code-block{label="Preview" preview} - :button-link[Play on StackBlitz]{icon="IconStackBlitz" href="https://stackblitz.com/github/nuxtlabs/docus-starter" blank} - :: +::code-block{label="Preview" preview} +:button-link[Play on StackBlitz]{icon="IconStackBlitz" href="https://stackblitz.com/github/nuxtlabs/docus-starter" blank} +:: - ```md [Code] - :button-link[Play on StackBlitz]{icon="IconStackBlitz" href="https://stackblitz.com/github/nuxtlabs/docus-starter" blank} - ``` +```md [Code] +:button-link[Play on StackBlitz]{icon="IconStackBlitz" href="https://stackblitz.com/github/nuxtlabs/docus-starter" blank} +``` :: - -::source-link ---- -source: "components/content/ButtonLink.vue" ---- +## ::source-link + +## source: "components/content/ButtonLink.vue" + :: --- @@ -190,10 +192,10 @@ source: "components/content/ButtonLink.vue" ::code-group - ::code-block{label="Preview"} - ::callout - #summary - This is a callout! Click me to open. +::code-block{label="Preview"} +::callout +#summary +This is a callout! Click me to open. #content This is the content of the callout. @@ -206,37 +208,38 @@ source: "components/content/ButtonLink.vue" #content This is the content of the callout. :: - :: - ```md [Code] - ::callout - #summary - This is a callout! Click me to open. +:: + +```md [Code] +::callout +#summary +This is a callout! Click me to open. + +#content +This is the content of the callout. +:: - #content - This is the content of the callout. - :: - - ::callout{type="warning"} - #summary - This is a callout! Click me to open. +::callout{type="warning"} +#summary +This is a callout! Click me to open. - #content - This is the content of the callout. - :: - ``` +#content +This is the content of the callout. +:: +``` :: - -::source-link ---- -source: "components/content/Callout.vue" ---- +## ::source-link + +## source: "components/content/Callout.vue" + :: --- @@ -245,40 +248,40 @@ source: "components/content/Callout.vue" ::code-group - ::code-block{label="Preview"} - ::card - --- - icon: logos:nuxt-icon - --- - #title - Nuxt Architecture. - #description - Based on **Nuxt 3** and **Nuxt Content**. :br - Use Nuxt to build a static site, or a serverless app. - :: - :: +::code-block{label="Preview"} +::card +--- +icon: logos:nuxt-icon +--- +#title +Nuxt Architecture. +#description +Based on **Nuxt 3** and **Nuxt Content**. :br +Use Nuxt to build a static site, or a serverless app. +:: +:: - ```md [Code] - ::card{icon="logos:nuxt-icon"} - #title - Nuxt Architecture. - #description - Based on **Nuxt 3** and **Nuxt Content**. :br - Use Nuxt to build a static site, or a serverless app. - :: - ``` +```md [Code] +::card{icon="logos:nuxt-icon"} +#title +Nuxt Architecture. +#description +Based on **Nuxt 3** and **Nuxt Content**. :br +Use Nuxt to build a static site, or a serverless app. +:: +``` :: - -::source-link ---- -source: "components/content/Card.vue" ---- +## ::source-link + +## source: "components/content/Card.vue" + :: --- @@ -286,11 +289,11 @@ source: "components/content/Card.vue" ## `` ::code-group - - ::code-block{label="Preview"} - ::card-grid - #title - What's included? + +::code-block{label="Preview"} +::card-grid +#title +What's included? #root :ellipsis @@ -315,49 +318,50 @@ source: "components/content/Card.vue" Enjoy the ease and simplicity of Markdown and discover MDC syntax. :: :: - :: - ```md [Code] - ::card-grid - #title - What's included +:: - #root - :ellipsis +```md [Code] +::card-grid +#title +What's included - #default - ::card - #title - Nuxt Architecture. - #description - Harness the full power of Nuxt and the Nuxt ecosystem. - :: - ::card - #title - Vue Components. - #description - Use built-in components (or your own!) inside your content. - :: - ::card - #title - Write Markdown. - #description - Enjoy the ease and simplicity of Markdown and discover MDC syntax. - :: - :: - ``` +#root +:ellipsis +#default +::card +#title +Nuxt Architecture. +#description +Harness the full power of Nuxt and the Nuxt ecosystem. :: +::card +#title +Vue Components. +#description +Use built-in components (or your own!) inside your content. +:: +::card +#title +Write Markdown. +#description +Enjoy the ease and simplicity of Markdown and discover MDC syntax. +:: +:: +``` - -::source-link ---- -source: "components/content/CardGrid.vue" ---- +## ::source-link + +## source: "components/content/CardGrid.vue" + :: --- @@ -368,35 +372,39 @@ This component uses `slots` to create a tab panel of your code examples or previ ::code-group - ::code-block{label="Preview" preview} - ::code-group - ```bash [Yarn] +::code-block{label="Preview" preview} +::code-group +`bash [Yarn] yarn add docus - ``` + ` ```bash [NPM] npm install docus ``` :: - :: - ```md [Code] - ::code-group - ```bash [Yarn] - yarn add docus - ``` - ```bash [NPM] - npm install docus - ``` - :: - ``` +:: + +````md [Code] +::code-group + +```bash [Yarn] +yarn add docus +``` + +```bash [NPM] +npm install docus +``` :: +```` + +:: + +## ::source-link + +## source: "components/content/CodeGroup.vue" -::source-link ---- -source: "components/content/CodeGroup.vue" ---- :: --- @@ -408,43 +416,42 @@ To be used inside a `` component to display a preview of some rende ::code-group ::code-block{label="Preview" preview} - ::badge - Hello World! - :: +::badge +Hello World! +:: :: ```md [Code] -/* Added as a child of `` */ +/_ Added as a child of `` _/ ::code-block{label="Preview" preview} - ::badge - Hello World! - :: +::badge +Hello World! +:: :: ``` :: - -::source-link ---- -source: "components/content/CodeBlock.vue" ---- +## ::source-link + +## source: "components/content/CodeBlock.vue" + :: --- ## `` - ::code-group ::code-block{label="Preview" preview} - :copy-button{content="hey!"} +:copy-button{content="hey!"} :: ```md [Code] @@ -453,15 +460,15 @@ source: "components/content/CodeBlock.vue" :: - -::source-link ---- -source: "components/content/CopyButton.vue" ---- +## ::source-link + +## source: "components/content/CopyButton.vue" + :: --- @@ -472,29 +479,29 @@ Icon component gives you access to all **100,000+** icons from [icones.js.org](h ::code-group - ::code-block{label="Preview" preview} - :icon{name="logos:nuxt-icon"} - :icon{name="logos:vue"} - :icon{name="logos:nuxt-icon"} - :: +::code-block{label="Preview" preview} +:icon{name="logos:nuxt-icon"} +:icon{name="logos:vue"} +:icon{name="logos:nuxt-icon"} +:: - ```md [Code] - :icon{name="logos:nuxt-icon"} - :icon{name="logos:vue"} - :icon{name="logos:nuxt-icon"} - ``` +```md [Code] +:icon{name="logos:nuxt-icon"} +:icon{name="logos:vue"} +:icon{name="logos:nuxt-icon"} +``` :: - -::source-link ---- -source: "components/content/Icon.vue" ---- +## ::source-link + +## source: "components/content/Icon.vue" + :: --- @@ -503,11 +510,9 @@ source: "components/content/Icon.vue" ::code-group - ::code-block{label="Preview" preview} - ::list{type="primary"} - - **Important** - - Always - :: +::code-block{label="Preview" preview} +::list{type="primary"} - **Important** - Always +:: ::list{type="success"} - Amazing @@ -529,50 +534,54 @@ source: "components/content/Icon.vue" - Driving drunk :: - :: +:: + +```md [Code] +::list{type="primary"} - ```md [Code] - ::list{type="primary"} - - **Important** - - Always +- **Important** +- Always :: - ::list{type="success"} - - Amazing - - Congrats +::list{type="success"} + +- Amazing +- Congrats :: - ::list{type="info"} - - Do you know? - - You can also do this +::list{type="info"} + +- Do you know? +- You can also do this :: - ::list{type="warning"} - - Be careful - - Use with precautions +::list{type="warning"} + +- Be careful +- Use with precautions :: - ::list{type="danger"} - - Drinking too much - - Driving drunk +::list{type="danger"} + +- Drinking too much +- Driving drunk :: - ``` +``` :: - -::source-link ---- -source: "components/content/List.vue" ---- +## ::source-link + +## source: "components/content/List.vue" + :: - + ## `` Embed CodeSandbox/StackBlitz easily in your documentation with great performances. @@ -613,25 +624,25 @@ Using the [IntersectionObserver](https://developer.mozilla.org/en-US/docs/Web/AP ::code-group - ::code-block{label="Preview" preview} - :sandbox{src="https://codesandbox.io/embed/nuxt-content-l164h?hidenavigation=1&theme=dark"} - :: +::code-block{label="Preview" preview} +:sandbox{src="https://codesandbox.io/embed/nuxt-content-l164h?hidenavigation=1&theme=dark"} +:: - ```md [Code] - :sandbox{src="https://codesandbox.io/embed/nuxt-content-l164h?hidenavigation=1&theme=dark"} - ``` +```md [Code] +:sandbox{src="https://codesandbox.io/embed/nuxt-content-l164h?hidenavigation=1&theme=dark"} +``` :: - -::source-link ---- -source: "components/content/Sandbox.vue" ---- +## ::source-link + +## source: "components/content/Sandbox.vue" + :: --- @@ -640,25 +651,25 @@ source: "components/content/Sandbox.vue" ::code-group - ::code-block{label="Preview" preview} - :terminal{content="nuxi build"} - :: +::code-block{label="Preview" preview} +:terminal{content="nuxi build"} +:: - ```md [Code] - :terminal{content="nuxi build"} - ``` +```md [Code] +:terminal{content="nuxi build"} +``` :: - -::source-link ---- -source: "components/content/Terminal.vue" ---- +## ::source-link + +## source: "components/content/Terminal.vue" + :: --- @@ -667,27 +678,27 @@ source: "components/content/Terminal.vue" ::code-group - ::code-block{label="Preview" preview} - ::div - :video-player{src="https://www.youtube.com/watch?v=o9e12WbKrd8"} - :: - :: +::code-block{label="Preview" preview} +::div +:video-player{src="https://www.youtube.com/watch?v=o9e12WbKrd8"} +:: +:: - ```md [Code] - ::div - :video-player{src="https://www.youtube.com/watch?v=o9e12WbKrd8"} - :: - ``` +```md [Code] +::div +:video-player{src="https://www.youtube.com/watch?v=o9e12WbKrd8"} +:: +``` :: - -::source-link ---- -source: "components/content/VideoPlayer.vue" ---- +## ::source-link + +## source: "components/content/VideoPlayer.vue" + :: diff --git a/apps/docs/content/2.api/2.composables.md b/apps/docs/content/2.api/2.composables.md index 4c0bea2..b4fa78b 100644 --- a/apps/docs/content/2.api/2.composables.md +++ b/apps/docs/content/2.api/2.composables.md @@ -14,7 +14,7 @@ The configs in `app.config` file will be used as defaults. ```vue