feat(minajs): add docs

mrcnk · mrcnk · commit 6c652b0b9b1b · 2024-09-03T15:33:01.000+02:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,34 @@
+name: Deploy to GitHub Pages
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout your repository using git
+        uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v2
+      - run: bun i --no-save
+      - run: bun run build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: apps/docs/docs/dist
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+        with:
+          artifact_name: docs
diff --git a/apps/docs/README.md b/apps/docs/README.md
@@ -0,0 +1 @@
+This is a [Vocs](https://vocs.dev) project bootstrapped with the Vocs CLI.
diff --git a/apps/docs/docs/footer.tsx b/apps/docs/docs/footer.tsx
@@ -0,0 +1,18 @@
+const Footer = () => {
+	return (
+		<p>
+			Maintained by{" "}
+			<a
+				href="https://palladians.xyz"
+				target="_blank"
+				rel="noopener noreferrer"
+				className="vocs_HomePage_packageManager underline"
+			>
+				Palladians
+			</a>
+			.
+		</p>
+	);
+};
+
+export default Footer;
diff --git a/apps/docs/docs/pages/example.mdx b/apps/docs/docs/pages/example.mdx
@@ -0,0 +1,3 @@
+# Example
+
+This is an example page.
diff --git a/apps/docs/docs/pages/getting-started.mdx b/apps/docs/docs/pages/getting-started.mdx
@@ -0,0 +1,3 @@
+# Get started
+
+Hello world!
diff --git a/apps/docs/docs/pages/index.mdx b/apps/docs/docs/pages/index.mdx
@@ -0,0 +1,15 @@
+---
+layout: landing
+---
+
+import { HomePage } from 'vocs/components'
+
+<HomePage.Root>
+  <img src="/logo.svg" className="w-24" />
+  <HomePage.Tagline>The TypeScript interface for Mina Protocol.</HomePage.Tagline>
+  <HomePage.Description>MinaJS is the missing piece for your smooth zkApp development on Mina.</HomePage.Description>
+  <HomePage.Buttons>
+    <HomePage.Button href="/getting-started" variant="accent">Get started</HomePage.Button>
+    <HomePage.Button href="https://github.com/palladians/mina-js">GitHub</HomePage.Button>
+  </HomePage.Buttons>
+</HomePage.Root>
diff --git a/apps/docs/docs/public/logo.svg b/apps/docs/docs/public/logo.svg
@@ -0,0 +1,18 @@
+<svg viewBox="0 0 189 129" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M0 129V1H24V129H0Z" fill="white"/>
+<path d="M74 129V1H98V129H74Z" fill="url(#paint0_linear_2399_16)"/>
+<path d="M98.001 108.999L7.00049 17.9702L23.9711 0.999653L98.001 75L98.001 108.999Z" fill="white"/>
+<path d="M171.51 108.48L81 17.9707L97.9706 1.00014L188.48 91.5098L171.51 108.48Z" fill="url(#paint1_linear_2399_16)"/>
+<defs>
+<linearGradient id="paint0_linear_2399_16" x1="86" y1="1" x2="86" y2="129" gradientUnits="userSpaceOnUse">
+<stop stop-color="white"/>
+<stop offset="0.165" stop-color="white"/>
+<stop offset="1" stop-opacity="0"/>
+</linearGradient>
+<linearGradient id="paint1_linear_2399_16" x1="89.4853" y1="9.48542" x2="179.995" y2="99.9951" gradientUnits="userSpaceOnUse">
+<stop stop-color="white"/>
+<stop offset="0.205" stop-color="white"/>
+<stop offset="1" stop-opacity="0"/>
+</linearGradient>
+</defs>
+</svg>
diff --git a/apps/docs/docs/styles.css b/apps/docs/docs/styles.css
@@ -0,0 +1,3 @@
+@layer vocs_preflight { @tailwind base; }
+@tailwind components;
+@tailwind utilities;
diff --git a/apps/docs/package.json b/apps/docs/package.json
@@ -0,0 +1,17 @@
+{
+	"name": "@mina-js/docs",
+	"version": "0.0.1",
+	"type": "module",
+	"scripts": {
+		"dev": "bunx vocs dev",
+		"build": "bunx vocs build",
+		"preview": "bunx vocs preview"
+	},
+	"dependencies": {
+		"@types/react": "latest",
+		"react": "latest",
+		"react-dom": "latest",
+		"typescript": "latest",
+		"vocs": "latest"
+	}
+}
diff --git a/apps/docs/tailwind.config.cjs b/apps/docs/tailwind.config.cjs
@@ -0,0 +1,8 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+	content: ["./docs/**/*.{html,md,mdx,tsx,js,jsx}"],
+	theme: {
+		extend: {},
+	},
+	plugins: [],
+};
diff --git a/apps/docs/tsconfig.json b/apps/docs/tsconfig.json
@@ -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"]
+}
diff --git a/apps/docs/vocs.config.ts b/apps/docs/vocs.config.ts
@@ -0,0 +1,66 @@
+import { defineConfig } from "vocs";
+
+export default defineConfig({
+	title: "MinaJS",
+	description: "The TypeScript interface for Mina Protocol.",
+	logoUrl: "/logo.svg",
+	theme: {
+		accentColor: {
+			light: "#907aa9",
+			dark: "#c4a7e7",
+		},
+		variables: {
+			color: {
+				background: {
+					light: "#fffaf3",
+					dark: "#1f1d2e",
+				},
+				backgroundDark: {
+					light: "#faf4ed",
+					dark: "#191724",
+				},
+				codeBlockBackground: {
+					light: "#faf4ed",
+					dark: "#191724",
+				},
+				codeTitleBackground: {
+					light: "#f2e9e1",
+					dark: "#26233a",
+				},
+				codeInlineBorder: {
+					light: "#9893a5",
+					dark: "#6e6a86",
+				},
+			},
+		},
+	},
+	socials: [
+		{ icon: "github", link: "https://github.com/palladians/mina-js" },
+		{ icon: "discord", link: "https://get.pallad.co/discord" },
+	],
+	sidebar: [
+		{
+			text: "Getting Started",
+			link: "/getting-started",
+		},
+		{
+			text: "MinaJS Connect",
+			link: "/connect",
+			items: [{ text: "Introduction", link: "/connect" }],
+		},
+		{
+			text: "MinaJS Accounts",
+			link: "/accounts",
+			items: [{ text: "Introduction", link: "/accounts" }],
+		},
+		{
+			text: "Klesia",
+			link: "/klesia",
+			items: [
+				{ text: "Introduction", link: "/klesia" },
+				{ text: "JSON-RPC", link: "/klesia/rpc" },
+				{ text: "TypeScript SDK", link: "/klesia/sdk" },
+			],
+		},
+	],
+});
diff --git a/apps/klesia/src/index.ts b/apps/klesia/src/index.ts
@@ -5,7 +5,7 @@ import { OpenAPIHono, createRoute } from "@hono/zod-openapi";
 import { PublicKeySchema } from "@mina-js/shared";
 import { apiReference } from "@scalar/hono-api-reference";
 import { rateLimiter } from "hono-rate-limiter";
-import { cors } from 'hono/cors'
+import { cors } from "hono/cors";
 import { logger } from "hono/logger";
 import { nanoid } from "nanoid";
 import { match } from "ts-pattern";
@@ -28,7 +28,7 @@ api.use(
 		limit: 10,
 	}),
 );
-api.use('/api', cors({ origin: '*' }))
+api.use("/api", cors({ origin: "*" }));
 
 api.doc("/api/openapi", {
 	openapi: "3.0.0",
diff --git a/bun.lockb b/bun.lockb
diff --git a/packages/klesia-sdk/src/client.ts b/packages/klesia-sdk/src/client.ts
@@ -9,9 +9,7 @@ export const createClient = ({
 	network,
 }: { network: "mainnet" | "devnet" }) => {
 	return match(NetworkMatcher.parse(network))
-		.with("devnet", () =>
-			hc<KlesiaRpc>("https://devnet.klesia.palladians.xyz"),
-		)
+		.with("devnet", () => hc<KlesiaRpc>("https://devnet.klesia.palladians.xyz"))
 		.with("mainnet", () =>
 			hc<KlesiaRpc>("https://mainnet.klesia.palladians.xyz"),
 		)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+This is a [Vocs](https://vocs.dev) project bootstrapped with the Vocs CLI.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Example`
	`2`	`+`
	`3`	`+This is an example page.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Get started`
	`2`	`+`
	`3`	`+Hello world!`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+@layer vocs_preflight { @tailwind base; }`
	`2`	`+@tailwind components;`
	`3`	`+@tailwind utilities;`