Skip to content

Commit e558729

Browse files
NiloCKNiloCK
committed
wip - vitepress docs
1 parent 15bb80a commit e558729

File tree

13 files changed

+1691
-48
lines changed

13 files changed

+1691
-48
lines changed

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,8 @@ ignore
4747

4848
# node pouchdb userdbs that get popped by `db` package sometimes. nuisance.
4949
userdb-Guest
50+
51+
# vitepress docs build/dev output
52+
53+
docs/.vitepress/dist
54+
docs/.vitepress/cache

‎docs/.vitepress/config.mts‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import { defineConfig } from 'vitepress';
2+
import path from 'path';
3+
4+
// https://vitepress.dev/reference/site-config
5+
export default defineConfig({
6+
vite: {
7+
resolve: {
8+
alias: {
9+
'@vue-skuilder/courseware': path.resolve(__dirname, '../../packages/courseware/src'),
10+
'@vue-skuilder/common-ui': path.resolve(__dirname, '../../packages/common-ui/src'),
11+
'@vue-skuilder/platform-ui': path.resolve(__dirname, '../../packages/platform-ui/src'),
12+
},
13+
},
14+
optimizeDeps: {
15+
exclude: ['@vue-skuilder/courseware', '@vue-skuilder/common-ui', '@vue-skuilder/platform-ui'],
16+
},
17+
},
18+
title: 'skuilder',
19+
description: 'modern tooling for adaptive tutoring systems and SRS++',
20+
themeConfig: {
21+
// https://vitepress.dev/reference/default-theme-config
22+
nav: [
23+
// { text: 'Home', link: '/' },
24+
// { text: 'Examples', link: '/markdown-examples' }
25+
],
26+
27+
sidebar: [
28+
{
29+
items: [
30+
{ text: 'Introduction', link: '/introduction' },
31+
{ text: 'Quickstart', link: '/quickstart' },
32+
],
33+
},
34+
],
35+
36+
socialLinks: [{ icon: 'github', link: 'https://github.com/patched-network/vue-skuilder' }],
37+
},
38+
});

‎docs/.vitepress/theme/index.ts‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// https://vitepress.dev/guide/custom-theme
2+
import { h } from 'vue'
3+
import type { Theme } from 'vitepress'
4+
import DefaultTheme from 'vitepress/theme'
5+
import './style.css'
6+
7+
export default {
8+
extends: DefaultTheme,
9+
Layout: () => {
10+
return h(DefaultTheme.Layout, null, {
11+
// https://vitepress.dev/guide/extending-default-theme#layout-slots
12+
})
13+
},
14+
enhanceApp({ app, router, siteData }) {
15+
// ...
16+
}
17+
} satisfies Theme

‎docs/.vitepress/theme/style.css‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
/**
2+
* Customize default theme styling by overriding CSS variables:
3+
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
4+
*/
5+
6+
/**
7+
* Colors
8+
*
9+
* Each colors have exact same color scale system with 3 levels of solid
10+
* colors with different brightness, and 1 soft color.
11+
*
12+
* - `XXX-1`: The most solid color used mainly for colored text. It must
13+
* satisfy the contrast ratio against when used on top of `XXX-soft`.
14+
*
15+
* - `XXX-2`: The color used mainly for hover state of the button.
16+
*
17+
* - `XXX-3`: The color for solid background, such as bg color of the button.
18+
* It must satisfy the contrast ratio with pure white (#ffffff) text on
19+
* top of it.
20+
*
21+
* - `XXX-soft`: The color used for subtle background such as custom container
22+
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
23+
* on top of it.
24+
*
25+
* The soft color must be semi transparent alpha channel. This is crucial
26+
* because it allows adding multiple "soft" colors on top of each other
27+
* to create an accent, such as when having inline code block inside
28+
* custom containers.
29+
*
30+
* - `default`: The color used purely for subtle indication without any
31+
* special meanings attached to it such as bg color for menu hover state.
32+
*
33+
* - `brand`: Used for primary brand colors, such as link text, button with
34+
* brand theme, etc.
35+
*
36+
* - `tip`: Used to indicate useful information. The default theme uses the
37+
* brand color for this by default.
38+
*
39+
* - `warning`: Used to indicate warning to the users. Used in custom
40+
* container, badges, etc.
41+
*
42+
* - `danger`: Used to show error, or dangerous message to the users. Used
43+
* in custom container, badges, etc.
44+
* -------------------------------------------------------------------------- */
45+
46+
:root {
47+
--vp-c-default-1: var(--vp-c-gray-1);
48+
--vp-c-default-2: var(--vp-c-gray-2);
49+
--vp-c-default-3: var(--vp-c-gray-3);
50+
--vp-c-default-soft: var(--vp-c-gray-soft);
51+
52+
--vp-c-brand-1: var(--vp-c-indigo-1);
53+
--vp-c-brand-2: var(--vp-c-indigo-2);
54+
--vp-c-brand-3: var(--vp-c-indigo-3);
55+
--vp-c-brand-soft: var(--vp-c-indigo-soft);
56+
57+
--vp-c-tip-1: var(--vp-c-brand-1);
58+
--vp-c-tip-2: var(--vp-c-brand-2);
59+
--vp-c-tip-3: var(--vp-c-brand-3);
60+
--vp-c-tip-soft: var(--vp-c-brand-soft);
61+
62+
--vp-c-warning-1: var(--vp-c-yellow-1);
63+
--vp-c-warning-2: var(--vp-c-yellow-2);
64+
--vp-c-warning-3: var(--vp-c-yellow-3);
65+
--vp-c-warning-soft: var(--vp-c-yellow-soft);
66+
67+
--vp-c-danger-1: var(--vp-c-red-1);
68+
--vp-c-danger-2: var(--vp-c-red-2);
69+
--vp-c-danger-3: var(--vp-c-red-3);
70+
--vp-c-danger-soft: var(--vp-c-red-soft);
71+
}
72+
73+
/**
74+
* Component: Button
75+
* -------------------------------------------------------------------------- */
76+
77+
:root {
78+
--vp-button-brand-border: transparent;
79+
--vp-button-brand-text: var(--vp-c-white);
80+
--vp-button-brand-bg: var(--vp-c-brand-3);
81+
--vp-button-brand-hover-border: transparent;
82+
--vp-button-brand-hover-text: var(--vp-c-white);
83+
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
84+
--vp-button-brand-active-border: transparent;
85+
--vp-button-brand-active-text: var(--vp-c-white);
86+
--vp-button-brand-active-bg: var(--vp-c-brand-1);
87+
}
88+
89+
/**
90+
* Component: Home
91+
* -------------------------------------------------------------------------- */
92+
93+
:root {
94+
--vp-home-hero-name-color: transparent;
95+
--vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe 30%, #41d1ff);
96+
97+
--vp-home-hero-image-background-image: linear-gradient(-45deg, #bd34fe 50%, #47caff 50%);
98+
--vp-home-hero-image-filter: blur(44px);
99+
}
100+
101+
@media (min-width: 640px) {
102+
:root {
103+
--vp-home-hero-image-filter: blur(56px);
104+
}
105+
}
106+
107+
@media (min-width: 960px) {
108+
:root {
109+
--vp-home-hero-image-filter: blur(68px);
110+
}
111+
}
112+
113+
/**
114+
* Component: Custom Block
115+
* -------------------------------------------------------------------------- */
116+
117+
:root {
118+
--vp-custom-block-tip-border: transparent;
119+
--vp-custom-block-tip-text: var(--vp-c-text-1);
120+
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
121+
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
122+
}
123+
124+
/**
125+
* Component: Algolia
126+
* -------------------------------------------------------------------------- */
127+
128+
.DocSearch {
129+
--docsearch-primary-color: var(--vp-c-brand-1) !important;
130+
}

‎docs/api-examples.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# Runtime API Examples
6+
7+
This page demonstrates usage of some of the runtime APIs provided by VitePress.
8+
9+
The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
10+
11+
```md
12+
<script setup>
13+
import { useData } from 'vitepress'
14+
15+
const { theme, page, frontmatter } = useData()
16+
</script>
17+
18+
## Results
19+
20+
### Theme Data
21+
<pre>{{ theme }}</pre>
22+
23+
### Page Data
24+
<pre>{{ page }}</pre>
25+
26+
### Page Frontmatter
27+
<pre>{{ frontmatter }}</pre>
28+
```
29+
30+
<script setup>
31+
import { useData } from 'vitepress'
32+
33+
const { site, theme, page, frontmatter } = useData()
34+
</script>
35+
36+
## Results
37+
38+
### Theme Data
39+
<pre>{{ theme }}</pre>
40+
41+
### Page Data
42+
<pre>{{ page }}</pre>
43+
44+
### Page Frontmatter
45+
<pre>{{ frontmatter }}</pre>
46+
47+
## More
48+
49+
Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

‎docs/cards.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Cards
2+
3+
<script setup>
4+
import FallingLetters from '@vue-skuilder/courseware/typing/questions/falling-letters/FallingLetters.vue'
5+
</script>
6+
7+
Test page with Vue components from monorepo.
8+
9+
<FallingLetters />

‎docs/glossary.md‎

Whitespace-only changes.

‎docs/index.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
# https://vitepress.dev/reference/default-theme-home-page
3+
layout: home
4+
5+
hero:
6+
name: "vue-skuilder"
7+
text: "tools for <code>SRS++</code> and interactive tutoring systems"
8+
tagline: Portable courseware for composable curricula.
9+
actions:
10+
- theme: brand
11+
text: Tell me more!
12+
link: /introduction
13+
- theme: alt
14+
text: Quickstart
15+
link: /quickstart
16+
- theme: alt
17+
text: GitHub
18+
link: https://github.com/patched-network/vue-skuilder
19+
20+
features:
21+
- title: Fully Extensible Flash Cards
22+
details: Build <strong><em>whatever</em></strong> types of content that you'd like. Midi interfaces, chess boards, you name it.
23+
- title: Pluggable Pedagogy
24+
details: "Mix and match naive SRS, ELO-based skill matching, and defined heirarchical paths. Or: bring fully custom implementations."
25+
- title: Local-First Philosophy
26+
details: User and course data comfortable on the server, but also browser-local and via static-site deployments.
27+
- title: AI Friendly <small>(but not dependant!)</small>
28+
details: Expose <strong>MCP</strong> servers for agent-assisted content authoring and course inspection.
29+
---

‎docs/introduction.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
`skuilder` (**Sk**ill B**uilder**) seeks to build on the legacy of great open-source personalized learning software (hi, [Anki](https://apps.ankiweb.net/?download)).
3+
4+
# Major Goals
5+
6+
**Friendlier end-user experiences** by default. Anki was and is a power tool that makes stiff demands on its users. Under this category we're interested in:
7+
- replacing card count configuration with time commitment configuration,
8+
-
9+
10+
**More interactive experiences** in context of individual cards.
11+
12+
**
13+
14+
# Overview
15+
16+
17+
18+
19+
# Roadmap
20+
21+
22+
23+
24+
# Caveats
25+
26+
This documentation is both *in-progess* and also not really intended to be *fully comprehensive*.
27+
28+
At present, the project's modular components require a little cajoling to work together in different contexts (eg, static-site vs live backend, standalone course vs course development platform).
29+
30+
This site focuses on **standalone** courses built for **static deployment** and browser-local user data.

0 commit comments

Comments
 (0)