Skip to content

Commit 6c91955

Browse files
committed
feat(docs): docs setup
1 parent 705bfa0 commit 6c91955

26 files changed

+27929
-11193
lines changed

package-lock.json

Lines changed: 27705 additions & 11192 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/docs/.env.example

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Create one with no scope selected on https://github.com/settings/tokens/new
2+
# This token is used for fetching the repository releases.
3+
GITHUB_TOKEN=

packages/docs/.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
node_modules
2+
*.iml
3+
.idea
4+
*.log*
5+
.nuxt
6+
.vscode
7+
.DS_Store
8+
coverage
9+
dist
10+
sw.*
11+
.env
12+
.output

packages/docs/.npmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
shamefully-hoist=true
2+
strict-peer-dependencies=false

packages/docs/README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Docus Starter
2+
3+
Starter template for [Docus](https://docus.dev).
4+
5+
## Clone
6+
7+
Clone the repository (using `nuxi`):
8+
9+
```bash
10+
npx nuxi init -t themes/docus
11+
```
12+
13+
## Setup
14+
15+
Install dependencies:
16+
17+
```bash
18+
yarn install
19+
```
20+
21+
## Development
22+
23+
```bash
24+
yarn dev
25+
```
26+
27+
## Edge Side Rendering
28+
29+
Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments.
30+
31+
Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets).
32+
33+
```bash
34+
yarn build
35+
```
36+
37+
## Static Generation
38+
39+
Use the `generate` command to build your application.
40+
41+
The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting.
42+
43+
```bash
44+
yarn generate
45+
```
46+
47+
## Preview build
48+
49+
You might want to preview the result of your build locally, to do so, run the following command:
50+
51+
```bash
52+
yarn preview
53+
```
54+
55+
---
56+
57+
For a detailed explanation of how things work, check out [Docus](https://docus.dev).

packages/docs/app.config.ts

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
export default defineAppConfig({
2+
docus: {
3+
title: 'Index-san',
4+
description: 'Documentation of app index-san',
5+
// image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png',
6+
socials: {
7+
// twitter: 'nuxt_themes',
8+
github: 'sidekick-coder/index-san',
9+
},
10+
aside: {
11+
level: 0,
12+
exclude: [],
13+
},
14+
header: {
15+
logo: true,
16+
showLinkIcon: true,
17+
exclude: [],
18+
},
19+
footer: {
20+
iconLinks: [
21+
// {
22+
// href: 'https://nuxt.com',
23+
// icon: 'IconNuxtLabs',
24+
// },
25+
],
26+
},
27+
},
28+
})

packages/docs/content/0.index.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Index-san
3+
navigation: false
4+
layout: page
5+
---
6+
7+
::block-hero
8+
---
9+
cta:
10+
- Get Started
11+
- /guide
12+
secondary:
13+
- Open on GitHub →
14+
- https://github.com/nuxtlabs/docus
15+
---
16+
17+
#title
18+
Organize your Notes and Databases in the way you want
19+
20+
#description
21+
Use a powerful combination of markdown, charts, js code to build your productivity system the way you want.
22+
23+
#extra
24+
::list
25+
- **Markdown notes:** create notes using markdown syntax.
26+
- **Markdown components:** buttons, cards, inputs, etc...
27+
- **Charts:** create beautiful charts based in your data.
28+
- **Custom scripts:** Run simple tasks like importer data from internet or other files.
29+
- **Based on Filesystem:** All your data is saved locally and you have full control of everything.
30+
::
31+
::
32+
::
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Get started
2+
3+
Todo
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
title: Guide

packages/docs/nuxt.config.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
export default defineNuxtConfig({
2+
extends: '@nuxt-themes/docus',
3+
})

packages/docs/package.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"name": "docs",
3+
"version": "0.0.0",
4+
"private": true,
5+
"scripts": {
6+
"dev": "nuxi dev",
7+
"build": "nuxi build",
8+
"generate": "nuxi generate",
9+
"preview": "nuxi preview"
10+
},
11+
"devDependencies": {
12+
"nuxt": "^3.0.0",
13+
"@nuxt-themes/docus": "^1.1.5"
14+
}
15+
}
21.9 KB
Loading
Loading
19.6 KB
Loading
765 Bytes
Loading
1.89 KB
Loading

packages/docs/public/favicon.ico

303 KB
Binary file not shown.

packages/docs/public/icon.png

101 KB
Loading

packages/docs/public/logo-dark.svg

Lines changed: 15 additions & 0 deletions
Loading

packages/docs/public/logo-light.svg

Lines changed: 15 additions & 0 deletions
Loading

packages/docs/public/preview.png

229 KB
Loading

packages/docs/public/site.webmanifest

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "",
3+
"short_name": "",
4+
"icons": [
5+
{
6+
"src": "/android-chrome-192x192.png",
7+
"sizes": "192x192",
8+
"type": "image/png"
9+
},
10+
{
11+
"src": "/android-chrome-512x512.png",
12+
"sizes": "512x512",
13+
"type": "image/png"
14+
}
15+
],
16+
"theme_color": "#ffffff",
17+
"background_color": "#ffffff",
18+
"display": "standalone"
19+
}

packages/docs/renovate.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"extends": [
3+
"@nuxtjs"
4+
],
5+
"lockFileMaintenance": {
6+
"enabled": true
7+
}
8+
}

packages/docs/tokens.config.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { defineTheme, palette } from 'pinceau'
2+
3+
export default defineTheme({
4+
colors: {
5+
primary: palette('orange'),
6+
},
7+
})

packages/docs/tsconfig.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": "./.nuxt/tsconfig.json"
3+
}

scripts/version.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ if (!versionName) {
88
}
99

1010
async function main() {
11-
const packages = ['core', 'desktop']
11+
const packages = ['core', 'desktop', 'docs', 'electron-app', 'tauri-app']
1212

1313
for await (const name of packages) {
1414
await command(`npm -w ${name} version ${versionName}`)

0 commit comments

Comments
 (0)