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

.eslintrc.cjs

@@ -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
   }

.gitignore

@@ -17,3 +17,8 @@ dist
 
 # Unlighthouse
 .unlighthouse
+
+# Starters lockfiles
+.starters/**/yarn.lock
+.starters/**/package-lock.json
+.starters/**/pnpm-lock.yaml

.starters/default/.eslintignore

@@ -0,0 +1,4 @@
+dist
+node_modules
+.output
+.nuxt

.starters/default/.eslintrc.cjs

@@ -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'
+  }
+}

.starters/default/.gitignore

@@ -0,0 +1,12 @@
+node_modules
+*.iml
+.idea
+*.log*
+.nuxt
+.vscode
+.DS_Store
+coverage
+dist
+sw.*
+.env
+.output

.starters/default/.npmrc

@@ -0,0 +1,2 @@
+shamefully-hoist=true
+strict-peer-dependencies=false

.starters/default/README.md

@@ -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).

.starters/default/app.config.ts

@@ -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'
+        }
+      ]
+    }
+  }
+})

.starters/default/nuxt.config.ts

@@ -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'
+  ]
+})

.starters/default/package.json

@@ -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"
+  }
+}

.starters/default/renovate.json

@@ -0,0 +1,8 @@
+{
+    "extends": [
+      "@nuxtjs"
+    ],
+    "lockFileMaintenance": {
+      "enabled": true
+    }
+}

.starters/default/tokens.config.ts

@@ -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
+})

.starters/default/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./.nuxt/tsconfig.json"
+}