Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
jhaaaa committed Jun 30, 2024
0 parents commit c80fcd5
Show file tree
Hide file tree
Showing 8 changed files with 103 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# production
/docs/dist

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# typescript
*.tsbuildinfo
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This is a [Vocs](https://vocs.dev) project bootstrapped with the Vocs CLI.
3 changes: 3 additions & 0 deletions docs/pages/example.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Example

This is an example page.
3 changes: 3 additions & 0 deletions docs/pages/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Get started

Hello world!
16 changes: 16 additions & 0 deletions docs/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
layout: landing
---

import { HomePage } from 'vocs/components'

<HomePage.Root>
<HomePage.Logo />
<HomePage.Tagline>My Awesome Docs</HomePage.Tagline>
<HomePage.InstallPackage name="vocs" type="init" />
<HomePage.Description>This is a description of my documentation website.</HomePage.Description>
<HomePage.Buttons>
<HomePage.Button href="/getting-started" variant="accent">Get started</HomePage.Button>
<HomePage.Button href="https://github.com/wevm/vocs">GitHub</HomePage.Button>
</HomePage.Buttons>
</HomePage.Root>
20 changes: 20 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "Docs",
"private": true,
"version": "0.0.0",
"type": "module",
"scripts": {
"dev": "vocs dev",
"build": "vocs build",
"preview": "vocs preview"
},
"dependencies": {
"react": "latest",
"react-dom": "latest",
"vocs": "latest"
},
"devDependencies": {
"@types/react": "latest",
"typescript": "latest"
}
}
24 changes: 24 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"compilerOptions": {
"target": "ES2020",
"useDefineForClassFields": true,
"lib": ["ES2020", "DOM", "DOM.Iterable"],
"module": "ESNext",
"skipLibCheck": true,

/* Bundler mode */
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "react-jsx",

/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true
},
"include": ["**/*.ts", "**/*.tsx"]
}
15 changes: 15 additions & 0 deletions vocs.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { defineConfig } from 'vocs'

export default defineConfig({
title: 'Docs',
sidebar: [
{
text: 'Getting Started',
link: '/getting-started',
},
{
text: 'Example',
link: '/example',
},
],
})

0 comments on commit c80fcd5

Please sign in to comment.