@matinfo/vitepress-plugin-quiz 0.9.9

package/README.md

@@ -0,0 +1,122 @@
+# vitepress-plugin-quiz
+
+[![npm version](https://img.shields.io/npm/v/vitepress-plugin-quiz?color=646cff)](https://www.npmjs.com/package/vitepress-plugin-quiz)
+[![npm downloads](https://img.shields.io/npm/dm/vitepress-plugin-quiz)](https://www.npmjs.com/package/vitepress-plugin-quiz)
+[![License: GPL-3.0](https://img.shields.io/badge/license-GPL--3.0-blue)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-brightgreen)](https://matinfo.github.io/vitepress-plugin-quiz/)
+
+A VitePress plugin that adds interactive quizzes to your Markdown pages using a simple `:::quiz` fenced block syntax.
+
+**Features:**
+- 📝 Single-choice, multiple-choice, and fill-in-the-blank questions
+- 💾 Session persistence — answers survive page navigation
+- 🌍 i18n: English, French, German, Italian, Spanish (or bring your own)
+- ♿ ARIA roles, keyboard navigation, screen-reader announcements
+- 🎨 VitePress CSS variables — dark mode and custom themes work out of the box
+- 🚀 Zero runtime dependencies beyond Vue
+
+---
+
+## Quick start
+
+### 1. Install
+
+```sh
+# bun
+bun add vitepress-plugin-quiz
+
+# npm
+npm install vitepress-plugin-quiz
+```
+
+### 2. Register the markdown plugin
+
+```ts
+// .vitepress/config.ts
+import { defineConfig } from "vitepress"
+import { quizMarkdownPlugin } from "vitepress-plugin-quiz"
+
+export default defineConfig({
+  markdown: {
+    config(md) {
+      md.use(quizMarkdownPlugin)
+    },
+  },
+})
+```
+
+### 3. Register Vue components + auto-inject styles
+
+```ts
+// .vitepress/theme/index.ts
+import DefaultTheme from "vitepress/theme"
+import { enhanceAppWithQuiz } from "vitepress-plugin-quiz"
+import type { Theme } from "vitepress"
+
+export default {
+  extends: DefaultTheme,
+  enhanceApp({ app }) {
+    enhanceAppWithQuiz(app) // English by default; pass "fr", "de", "it", or "es"
+  },
+} satisfies Theme
+```
+
+### 4. Write quizzes in Markdown
+
+```md
+:::quiz
+question: What does CSS stand for?
+answer: Computer Style Sheets
+answer-correct: Cascading Style Sheets
+answer: Creative Style Sheets
+explanation: CSS = **Cascading Style Sheets** — the language that styles web pages.
+shuffle: true
+:::
+
+:::quiz
+question: What CSS property controls text color?
+answer-input: color
+explanation: The `color` property sets the foreground text colour.
+:::
+```
+
+---
+
+## Documentation
+
+Full guide, syntax reference, i18n docs, and live examples at:  
+**[https://matinfo.github.io/vitepress-plugin-quiz/](https://matinfo.github.io/vitepress-plugin-quiz/)**
+
+---
+
+## API
+
+### `quizMarkdownPlugin(md)`
+
+markdown-it plugin. Use in `.vitepress/config.ts` under `markdown.config`.
+
+### `enhanceAppWithQuiz(app, lang?)`
+
+Registers `<QuizQuestion>` and `<QuizPage>` on the Vue app, provides the locale, and auto-injects styles. `lang` defaults to `"en"`.
+
+### `getLocale(lang?)` / `locales`
+
+Access locale strings directly. `getLocale` falls back to English for unknown codes.
+
+### Types
+
+All TypeScript interfaces are re-exported from the main entry:
+
+```ts
+import type { QuizData, QuizAnswer, QuizLocale, QuizState } from "vitepress-plugin-quiz"
+```
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+[GPL-3.0](LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './src/index'
+export {}

package/dist/src/QuizPage.vue.d.ts

@@ -0,0 +1,17 @@
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/src/QuizQuestion.vue.d.ts

@@ -0,0 +1,12 @@
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    dataQuiz: {
+        type: StringConstructor;
+        required: true;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    dataQuiz: {
+        type: StringConstructor;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/src/__tests__/locales.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/__tests__/mdPlugin.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/__tests__/richText.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/index.d.ts

@@ -0,0 +1,21 @@
+import { App } from 'vue';
+import { default as QuizQuestion } from './QuizQuestion.vue';
+import { default as QuizPage } from './QuizPage.vue';
+export { quizMarkdownPlugin } from './md-plugin';
+export { getLocale, locales } from './locales';
+export type { QuizData, QuizAnswer, QuizLocale, QuizState, SavedAnswer } from './types/quiz';
+export { QuizQuestion, QuizPage };
+/**
+ * Register quiz components and locale in a VitePress `enhanceApp` hook.
+ *
+ * @example
+ * // .vitepress/theme/index.ts
+ * import { enhanceAppWithQuiz } from 'vitepress-plugin-quiz'
+ * export default {
+ *   enhanceApp({ app }) {
+ *     enhanceAppWithQuiz(app)        // English (default)
+ *     enhanceAppWithQuiz(app, 'fr')  // French
+ *   }
+ * }
+ */
+export declare function enhanceAppWithQuiz(app: App, lang?: string): void;

package/dist/src/locales.d.ts

@@ -0,0 +1,7 @@
+import { QuizLocale } from './types/quiz';
+export declare const locales: Record<string, QuizLocale>;
+/**
+ * Get locale strings for a given language code.
+ * Falls back to English if the language is not found.
+ */
+export declare function getLocale(lang?: string): QuizLocale;

package/dist/src/md-plugin.d.ts

@@ -0,0 +1,9 @@
+import { default as MarkdownIt } from 'markdown-it';
+import { QuizData } from './types/quiz';
+/**
+ * Register the quiz block rule on a markdown-it instance.
+ * Use in VitePress config:
+ *   markdown: { config(md) { md.use(quizMarkdownPlugin) } }
+ */
+export declare function quizMarkdownPlugin(md: MarkdownIt): void;
+export declare function parseQuizBlock(lines: string[]): QuizData | null;

package/dist/src/styleManager.d.ts

@@ -0,0 +1 @@
+export declare function ensureStylesInjected(): void;

package/dist/src/types/quiz.d.ts

@@ -0,0 +1,37 @@
+export interface QuizAnswer {
+    text: string;
+    correct: boolean;
+    originalIndex?: number;
+}
+export interface QuizData {
+    question: string;
+    type: "choice" | "input";
+    answers: QuizAnswer[];
+    expected: string[];
+    explanation: string;
+    shuffle: boolean;
+}
+export interface QuizLocale {
+    answered: string;
+    validate: string;
+    reset: string;
+    correctAnswers: (n: number) => string;
+    multipleHint: string;
+    explanation: string;
+    inputHint: string;
+    inputPlaceholder: string;
+    expectedAnswer: string;
+}
+export interface QuizState {
+    answered: boolean;
+    isCorrect: boolean;
+}
+export interface SavedChoiceAnswer {
+    type: "choice";
+    selected: number[];
+}
+export interface SavedInputAnswer {
+    type: "input";
+    input: string;
+}
+export type SavedAnswer = SavedChoiceAnswer | SavedInputAnswer;

package/dist/src/utils.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Inline markdown part — result of {@link parseRichText}.
+ */
+export type RichPart = {
+    type: "text" | "bold" | "italic" | "code";
+    value: string;
+};
+/**
+ * Parse inline markdown subsets: **bold**, *italic*, `code` → typed parts array.
+ * Used for question titles, answer text, and explanations.
+ */
+export declare function parseRichText(text: string): RichPart[];

package/dist/vite.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vite').UserConfig;
+export default _default;