Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(starter): move docus-starter inside this repository #904

Merged
merged 2 commits into from
May 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 0 additions & 80 deletions .docs/.studio/app.config.json

This file was deleted.

11 changes: 0 additions & 11 deletions .docs/nuxt.config.ts

This file was deleted.

Binary file removed .docs/public/favicon.ico
Binary file not shown.
4 changes: 0 additions & 4 deletions .docs/tokens.config.ts

This file was deleted.

4 changes: 0 additions & 4 deletions .docs/tsconfig.json

This file was deleted.

6 changes: 3 additions & 3 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
module.exports = {
root: true,
extends: [
'@nuxt/eslint-config'
],
extends: ['@nuxt/eslint-config'],
rules: {
// Global
semi: ['error', 'never'],
quotes: ['error', 'single'],
'quote-props': ['error', 'as-needed'],
'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],

// Vue
indent: ['error', 2],
'vue/multi-word-component-names': 0,
'vue/no-v-html': 0
}
Expand Down
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,8 @@ dist

# Unlighthouse
.unlighthouse

# Starters lockfiles
.starters/**/yarn.lock
.starters/**/package-lock.json
.starters/**/pnpm-lock.yaml
15 changes: 0 additions & 15 deletions .playground/app.config.ts

This file was deleted.

17 changes: 0 additions & 17 deletions .playground/components/content/CounterButton.vue

This file was deleted.

18 changes: 0 additions & 18 deletions .playground/content/0.index.md

This file was deleted.

4 changes: 0 additions & 4 deletions .playground/nuxt.config.ts

This file was deleted.

Binary file removed .playground/public/cover.png
Binary file not shown.
Binary file removed .playground/public/favicon.ico
Binary file not shown.
4 changes: 0 additions & 4 deletions .playground/tsconfig.json

This file was deleted.

4 changes: 4 additions & 0 deletions .starters/default/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dist
node_modules
.output
.nuxt
8 changes: 8 additions & 0 deletions .starters/default/.eslintrc.cjs
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'
}
}
12 changes: 12 additions & 0 deletions .starters/default/.gitignore
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
2 changes: 2 additions & 0 deletions .starters/default/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
shamefully-hoist=true
strict-peer-dependencies=false
57 changes: 57 additions & 0 deletions .starters/default/README.md
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).
46 changes: 46 additions & 0 deletions .starters/default/app.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
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',
socials: {
twitter: 'nuxtstudio',
github: 'nuxt-themes/docus'
},
github: {
dir: '.starters/default/content',
branch: 'main',
repo: 'docus',
owner: 'nuxt-themes',
edit: true
},
aside: {
level: 0,
collapsed: false,
exclude: []
},
main: {
padded: true,
fluid: true
},
header: {
logo: true,
showLinkIcon: true,
exclude: [],
fluid: true
},
footer: {
iconLinks: [
{
href: 'https://nuxt.com',
icon: 'simple-icons:nuxtdotjs'
},
{
href: 'https://nuxt.com',
icon: 'IconNuxtLabs',
label: 'Nuxt'
}
]
}
}
})
File renamed without changes.
File renamed without changes.
12 changes: 12 additions & 0 deletions .starters/default/nuxt.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
export default defineNuxtConfig({
// https://github.com/nuxt-themes/docus
extends: '@nuxt-themes/docus',

modules: [
// https://github.com/nuxt-modules/plausible
'@nuxtjs/plausible',

// https://github.com/nuxt/devtools
'@nuxt/devtools'
]
})
19 changes: 19 additions & 0 deletions .starters/default/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "docus-starter",
"version": "0.1.0",
"private": true,
"scripts": {
"dev": "nuxi dev",
"build": "nuxi build",
"generate": "nuxi generate",
"preview": "nuxi preview",
"lint": "eslint ."
},
"devDependencies": {
"@nuxt-themes/docus": "^1.11.1",
"@nuxtjs/plausible": "^0.2.1",
"@nuxt/eslint-config": "^0.1.1",
"eslint": "^8.40.0",
"nuxt": "3.3.3"
}
}
File renamed without changes
Binary file added .starters/default/public/favicon.ico
Binary file not shown.
8 changes: 8 additions & 0 deletions .starters/default/renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"extends": [
"@nuxtjs"
],
"lockFileMaintenance": {
"enabled": true
}
}
9 changes: 9 additions & 0 deletions .starters/default/tokens.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { defineTheme } from 'pinceau'

export default defineTheme({
// Defaults from:
// 1. https://github.com/nuxt-themes/tokens
// 2. https://github.com/nuxt-themes/typography/blob/main/tokens.config.ts
// 3. https://github.com/nuxt-themes/elements/blob/main/tokens.config.ts
// 4. https://github.com/nuxt-themes/docus/blob/main/tokens.config.ts
})
3 changes: 3 additions & 0 deletions .starters/default/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "./.nuxt/tsconfig.json"
}
Loading