Skip to content

Commit

Permalink
Documentation website
Browse files Browse the repository at this point in the history
  • Loading branch information
tuler committed Jul 24, 2024
1 parent 8fd7a4c commit 20da387
Show file tree
Hide file tree
Showing 9 changed files with 3,397 additions and 127 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ dist-ssr
server/dist
public/dist
.turbo
docs
/docs
6 changes: 6 additions & 0 deletions apps/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Documentation

```shell
pnpm install
pnpm run dev
```
3 changes: 3 additions & 0 deletions apps/docs/docs/pages/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Get started

(Coming soon!)
16 changes: 16 additions & 0 deletions apps/docs/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>TypeScript libraries for Cartesi applications</HomePage.Tagline>
<HomePage.InstallPackage name="@deroll/app" type="init" />
<HomePage.Description>deroll is a set of libraries that helps the development of Cartesi applications, both on the backend and on the frontend.</HomePage.Description>
<HomePage.Buttons>
<HomePage.Button href="/getting-started" variant="accent">Get started</HomePage.Button>
<HomePage.Button href="https://github.com/tuler/deroll">GitHub</HomePage.Button>
</HomePage.Buttons>
</HomePage.Root>
17 changes: 17 additions & 0 deletions apps/docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "@deroll/docs",
"version": "0.0.0",
"type": "module",
"scripts": {
"dev": "vocs dev",
"build": "vocs build",
"preview": "vocs preview"
},
"dependencies": {
"@types/react": "latest",
"react": "latest",
"react-dom": "latest",
"typescript": "latest",
"vocs": "latest"
}
}
24 changes: 24 additions & 0 deletions apps/docs/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"]
}
8 changes: 8 additions & 0 deletions apps/docs/turbo.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"extends": ["//"],
"tasks": {
"build": {
"outputs": ["docs/dist/**"]
}
}
}
12 changes: 12 additions & 0 deletions apps/docs/vocs.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { defineConfig } from "vocs";

export default defineConfig({
baseUrl: "https://deroll.dev",
sidebar: [
{
text: "Getting Started",
link: "/getting-started",
},
],
title: "deroll",
});
Loading

0 comments on commit 20da387

Please sign in to comment.