Skip to content

Commit 60738f1

Browse files
claymcleodclaymcleod
committed
feat: introduces docs and a few minor text changes
1 parent b28fc79 commit 60738f1

27 files changed

Lines changed: 9383 additions & 99 deletions

‎.gitignore‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,24 @@
1-
book
1+
# Nuxt dev/build outputs
2+
.output
3+
.data
4+
.nuxt
5+
.nitro
6+
.cache
7+
dist
8+
9+
# Node dependencies
10+
node_modules
11+
12+
# Logs
13+
logs
14+
*.log
15+
16+
# Misc
17+
.DS_Store
18+
.fleet
19+
.idea
20+
21+
# Local env files
22+
.env
23+
.env.*
24+
!.env.example

‎README.md‎

Lines changed: 74 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,75 @@
1-
# Charter
1+
# Nuxt 3 Minimal Starter
22

3-
The project charter for `rust-seq`.
3+
Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
4+
5+
## Setup
6+
7+
Make sure to install the dependencies:
8+
9+
```bash
10+
# npm
11+
npm install
12+
13+
# pnpm
14+
pnpm install
15+
16+
# yarn
17+
yarn install
18+
19+
# bun
20+
bun install
21+
```
22+
23+
## Development Server
24+
25+
Start the development server on `http://localhost:3000`:
26+
27+
```bash
28+
# npm
29+
npm run dev
30+
31+
# pnpm
32+
pnpm run dev
33+
34+
# yarn
35+
yarn dev
36+
37+
# bun
38+
bun run dev
39+
```
40+
41+
## Production
42+
43+
Build the application for production:
44+
45+
```bash
46+
# npm
47+
npm run build
48+
49+
# pnpm
50+
pnpm run build
51+
52+
# yarn
53+
yarn build
54+
55+
# bun
56+
bun run build
57+
```
58+
59+
Locally preview production build:
60+
61+
```bash
62+
# npm
63+
npm run preview
64+
65+
# pnpm
66+
pnpm run preview
67+
68+
# yarn
69+
yarn preview
70+
71+
# bun
72+
bun run preview
73+
```
74+
75+
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.

‎app.vue‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<template>
2+
<div>
3+
<NuxtLayout>
4+
<NuxtPage />
5+
</NuxtLayout>
6+
</div>
7+
</template>
8+
9+
<style lang="postcss">
10+
* {
11+
@apply text-slate-900;
12+
@apply dark:text-slate-300;
13+
}
14+
</style>

‎assets/css/main.css‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
@font-face {
2+
font-family: Hanken Grotesk;
3+
src: url("~/assets/fonts/HankenGrotesk.ttf");
4+
}

‎assets/fonts/HankenGrotesk.ttf‎

130 KB
Binary file not shown.

‎book.toml‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎components/docs/LeftSidebar.vue‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
<template>
2+
<div class="sidebar">
3+
<div class="search">
4+
<div>
5+
<input type="text" id="search" placeholder="Search (Not Implemented)" />
6+
</div>
7+
</div>
8+
<div class="links">
9+
<div class="header">Get Started</div>
10+
<RouterLink to="/docs/overview">Overview</RouterLink>
11+
<RouterLink to="/docs/values">Values</RouterLink>
12+
<RouterLink to="/docs/stack">Stack</RouterLink>
13+
</div>
14+
</div>
15+
</template>
16+
17+
<style scoped lang="postcss">
18+
.sidebar {
19+
@apply flex;
20+
@apply flex-col;
21+
@apply justify-start;
22+
@apply items-start;
23+
24+
@apply w-[260px];
25+
@apply h-full;
26+
27+
@apply pl-[20px];
28+
@apply py-4;
29+
30+
@apply bg-slate-50;
31+
@apply dark:bg-slate-950;
32+
33+
@apply text-slate-600;
34+
@apply hover:text-slate-700;
35+
@apply dark:text-slate-300;
36+
@apply dark:hover:text-gray-50;
37+
38+
@apply border-2;
39+
@apply border-l-0;
40+
@apply border-slate-200;
41+
@apply dark:border-slate-900;
42+
43+
.search {
44+
@apply mb-6;
45+
@apply pr-[20px];
46+
47+
label {
48+
@apply block;
49+
50+
@apply mb-2;
51+
52+
@apply text-sm;
53+
@apply font-medium;
54+
@apply text-gray-900;
55+
@apply dark:text-white;
56+
}
57+
58+
input {
59+
@apply block;
60+
61+
@apply w-full;
62+
63+
@apply p-2.5;
64+
65+
@apply rounded-lg;
66+
67+
@apply dark:bg-slate-800;
68+
69+
@apply border;
70+
@apply border-gray-200;
71+
@apply dark:border-gray-600;
72+
73+
@apply placeholder-gray-700;
74+
@apply dark:placeholder-gray-300;
75+
76+
@apply text-sm;
77+
@apply text-gray-900;
78+
@apply dark:text-white;
79+
80+
@apply focus:ring-blue-500;
81+
@apply focus:border-blue-500;
82+
@apply dark:focus:ring-blue-500;
83+
@apply dark:focus:border-blue-500;
84+
}
85+
}
86+
87+
.links {
88+
@apply w-full;
89+
90+
.header {
91+
@apply pb-1;
92+
@apply pl-3;
93+
94+
font-size: 14px;
95+
@apply font-bold;
96+
@apply tracking-wide;
97+
@apply text-gray-800;
98+
@apply dark:text-gray-200;
99+
}
100+
101+
a {
102+
@apply transition;
103+
@apply block;
104+
@apply rounded-l-lg;
105+
106+
@apply w-full;
107+
108+
@apply pl-3;
109+
@apply py-0.5;
110+
111+
font-size: 16px;
112+
line-height: 1.75rem;
113+
@apply text-gray-500;
114+
@apply dark:text-gray-400;
115+
116+
@apply hover:text-gray-800;
117+
@apply dark:hover:text-gray-300;
118+
}
119+
120+
a.active {
121+
@apply border-r-4;
122+
@apply text-slate-900;
123+
@apply dark:text-white;
124+
125+
@apply bg-orange-200;
126+
@apply dark:bg-orange-600;
127+
128+
@apply border-orange-500;
129+
@apply dark:border-orange-800;
130+
}
131+
}
132+
}
133+
</style>

‎components/docs/RightSidebar.vue‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<script setup lang="ts">
2+
import { Toc } from "@nuxt/content";
3+
4+
const props = defineProps<{
5+
toc: Toc;
6+
}>();
7+
</script>
8+
9+
<template>
10+
<div v-if="toc.links !== undefined && toc.links.length > 0">
11+
<h4>Table of Contents</h4>
12+
<ul>
13+
<li v-for="link of toc.links" :key="link.id">
14+
<a :href="`#${link.id}`">{{ link.text }}</a>
15+
</li>
16+
</ul>
17+
</div>
18+
</template>
19+
20+
<style scoped lang="postcss">
21+
h4 {
22+
@apply font-bold;
23+
font-size: 14px;
24+
@apply pb-1;
25+
}
26+
27+
ul > li:not(:last-child) {
28+
@apply pb-0.5;
29+
}
30+
</style>

‎components/global/ColorMode.vue‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<template>
2+
<LucideMoon
3+
v-if="colorMode.preference === Mode.Light"
4+
@click="colorMode.preference = Mode.Dark"
5+
/>
6+
<LucideSun v-else @click="colorMode.preference = Mode.Light" />
7+
</template>
8+
9+
<script setup lang="ts">
10+
const colorMode = useColorMode();
11+
12+
enum Mode {
13+
Light = "light",
14+
Dark = "dark",
15+
System = "system",
16+
}
17+
18+
colorMode.preference = Mode.System;
19+
</script>

‎components/global/ContextMenu.vue‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<template>
2+
<nav>
3+
<div id="links">
4+
<NuxtLink to="/docs">
5+
<LucideBookText class="mx-auto" />
6+
<span class="label">Docs</span>
7+
</NuxtLink>
8+
</div>
9+
10+
<ColorMode />
11+
</nav>
12+
</template>
13+
14+
<style scoped lang="postcss">
15+
nav {
16+
#links {
17+
@apply flex;
18+
@apply flex-col;
19+
@apply justify-start;
20+
@apply items-center;
21+
}
22+
23+
@apply flex;
24+
@apply flex-col;
25+
@apply justify-between;
26+
@apply items-center;
27+
28+
@apply w-[50px];
29+
@apply h-full;
30+
31+
@apply py-4;
32+
33+
@apply bg-slate-100;
34+
@apply dark:bg-slate-950;
35+
36+
@apply text-gray-500;
37+
@apply hover:text-gray-700;
38+
@apply dark:text-gray-200;
39+
@apply dark:hover:text-gray-50;
40+
41+
@apply border-2;
42+
@apply border-slate-200;
43+
@apply dark:border-slate-900;
44+
45+
a {
46+
margin-bottom: 20px;
47+
48+
.label {
49+
@apply text-xs;
50+
@apply font-bold;
51+
@apply uppercase;
52+
@apply transition;
53+
}
54+
}
55+
}
56+
</style>

0 commit comments

Comments
 (0)