-
Notifications
You must be signed in to change notification settings - Fork 80
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
25 changed files
with
24,027 additions
and
983 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 |
---|---|---|
|
@@ -13,3 +13,7 @@ stats.html | |
# Local Netlify folder | ||
.netlify | ||
dist | ||
|
||
docs/.vitepress/dist | ||
docs/.vitepress/cache | ||
.vitepress |
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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
dist | ||
node_modules | ||
.output | ||
.nuxt |
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 |
---|---|---|
@@ -0,0 +1,8 @@ | ||
module.exports = { | ||
root: true, | ||
extends: '@nuxt/eslint-config', | ||
rules: { | ||
'vue/max-attributes-per-line': 'off', | ||
'vue/multi-word-component-names': 'off' | ||
} | ||
} |
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 |
---|---|---|
@@ -0,0 +1,12 @@ | ||
node_modules | ||
*.iml | ||
.idea | ||
*.log* | ||
.nuxt | ||
.vscode | ||
.DS_Store | ||
coverage | ||
dist | ||
sw.* | ||
.env | ||
.output |
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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
shamefully-hoist=true | ||
strict-peer-dependencies=false |
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 |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# Docus Starter | ||
|
||
Starter template for [Docus](https://docus.dev). | ||
|
||
## Clone | ||
|
||
Clone the repository (using `nuxi`): | ||
|
||
```bash | ||
npx nuxi init -t themes/docus | ||
``` | ||
|
||
## Setup | ||
|
||
Install dependencies: | ||
|
||
```bash | ||
yarn install | ||
``` | ||
|
||
## Development | ||
|
||
```bash | ||
yarn dev | ||
``` | ||
|
||
## Edge Side Rendering | ||
|
||
Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments. | ||
|
||
Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets). | ||
|
||
```bash | ||
yarn build | ||
``` | ||
|
||
## Static Generation | ||
|
||
Use the `generate` command to build your application. | ||
|
||
The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting. | ||
|
||
```bash | ||
yarn generate | ||
``` | ||
|
||
## Preview build | ||
|
||
You might want to preview the result of your build locally, to do so, run the following command: | ||
|
||
```bash | ||
yarn preview | ||
``` | ||
|
||
--- | ||
|
||
For a detailed explanation of how things work, check out [Docus](https://docus.dev). |
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 |
---|---|---|
@@ -0,0 +1,27 @@ | ||
export default defineAppConfig({ | ||
docus: { | ||
title: "Vinxi", | ||
description: "The app framework that grows with you.", | ||
image: | ||
"https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png", | ||
socials: { | ||
twitter: "nuxtstudio", | ||
github: "nuxt-themes/docus", | ||
}, | ||
aside: { | ||
level: 0, | ||
exclude: [], | ||
}, | ||
header: { | ||
logo: true, | ||
}, | ||
footer: { | ||
iconLinks: [ | ||
{ | ||
href: "https://nuxt.com", | ||
icon: "simple-icons:nuxtdotjs", | ||
}, | ||
], | ||
}, | ||
}, | ||
}); |
Binary file not shown.
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 |
---|---|---|
@@ -0,0 +1,72 @@ | ||
--- | ||
title: My Docus project | ||
navigation: false | ||
layout: page | ||
--- | ||
|
||
::block-hero | ||
--- | ||
cta: | ||
- Get Started | ||
- /guide | ||
secondary: | ||
- Open on GitHub → | ||
- https://github.com/nksaraf/vinxi | ||
snippet: npm install vinxi | ||
--- | ||
|
||
#title | ||
The App Framework | ||
|
||
#description | ||
Develop universal full stack apps like its nothing. Build them optimally. Deploy them anywhere you feel like. | ||
:: | ||
|
||
::card-grid | ||
#title | ||
What's included | ||
|
||
#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. | ||
:: | ||
|
||
features: | ||
- title: Deploy Anywhere | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Web Standards Everywhere | ||
# icon: ❤️ | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Bring your own UI Framework | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Hackable | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Built on backs of giants | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Vite/Rollup Plugin API | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Bring your own opinions | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Hot Develepment Experience | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Ultra-fast Production Apps | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
:: |
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 |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Get started | ||
|
||
Let's get started with Docus. | ||
|
||
# Welcome to Docus | ||
|
||
Your new favorite way to build **documentation**. | ||
|
||
## How to use Docus ? | ||
|
||
Learn more on [docus.dev](https://docus.dev). | ||
|
||
::code-group | ||
|
||
```bash [npm] | ||
npm install vinxi | ||
``` | ||
|
||
```bash [yarn] | ||
yarn add vinxi | ||
``` | ||
|
||
```bash [pnpm] | ||
pnpm add vinxi | ||
``` | ||
:: |
Oops, something went wrong.