VitePress Plugin

Add OER Schema pedagogical components to your VitePress documentation with semantic markup and beautiful styling.

Quick Installation

1. Install from npm

npm install vitepress-plugin-oer-schema

2. Configure VitePress

import { oerSchemaPlugin } from 'vitepress-plugin-oer-schema'

export default {
  markdown: {
    config: (md) => md.use(oerSchemaPlugin)
  }
}

3. Import Styles

import 'vitepress-plugin-oer-schema/styles.css'

Example Usage

Here's how to use the components in your VitePress markdown files:

::: learning-objective skill="analyze data" course="DATA-101"
Students will be able to analyze and interpret data using statistical methods.
:::

::: practice action="Analyzing,Computing" material="dataset-csv"
**Exercise: Sales Data Analysis**
Download the sales dataset and calculate key metrics...
:::

::: assessment type="Project" points="100" assessing="data-analysis"
**Final Project: Data Analysis Report**
Create a comprehensive analysis of the provided dataset...
:::

::: rubric type="analytic"
**Assignment Rubric**

::: rubric-criterion weight="40"
**Data Analysis Quality**
::: rubric-scale pointsRequired="true"
::: rubric-level ordinal="3" points="40"
Excellent analysis with clear insights
:::
::: rubric-level ordinal="2" points="30"
Good analysis with some insights
:::
::: rubric-level ordinal="1" points="20"
Basic analysis
:::
:::
:::
:::

View on npm • Version 0.2.1