educandu-plugin-embedded-html

An embedded HTML plugin for educandu

Prerequisites

• node.js ^20.0.0
• optional: globally installed gulp: npm i -g gulp-cli

The output of this repository is an npm package (@musikisum/educandu-plugin-embedded-html).

Development

• Clone this repository
• Run yarn install
• Use gulp build to build the plugin

Usage

Import the published package into your educandu driven website:

$ yarn add @musikisum/educandu-plugin-embedded-html

Add the plugin info to the application's custom resolvers module:

import EmbeddedHtmlPlugin from '@musikisum/educandu-plugin-embedded-html';

export default {
  resolveCustomPageTemplate: null,
  resolveCustomHomePageTemplate: null,
  resolveCustomSiteLogo: null,
  resolveCustomPluginInfos: () => [EmbeddedHtmlPlugin]
};

Add the plugin name and the translations to your server config:

import educandu from '@educandu/educandu';
import { createRequire } from 'node:module';

const require = createRequire(import.meta.url);
const embeddedHtmlPluginTranslationsPath = require.resolve('@musikisum/educandu-plugin-embedded-html/translations.json');

educandu({
  plugins: [/* your other plugins here */, 'musikisum/educandu-plugin-embedded-html'],
  resources: [/* your other translations here */, embeddedHtmlPluginTranslationsPath],
  /* your other server config here */
});

Import the plugin styles to your main LESS entry point:

// Base styles from Educandu:
@import url('@educandu/educandu/styles/main.less');

// Styles for the custom plugin:
@import url('@musikisum/educandu-plugin-embedded-html/embedded-html.less');

// Other styles here

Naming conventions

• Namespace: musikisum
• Plugin name: embedded-html
• npm / GitHub name: musikisum/educandu-plugin-embedded-html
• CSS class prefix: EP_Musikisum_EmbeddedHtml_
• typeName: musikisum/educandu-plugin-embedded-html

OER learning platform for music

Funded by 'Stiftung Innovation in der Hochschullehre'

A Project of the 'Hochschule für Musik und Theater München' (University for Music and Performing Arts)

Project owner: Hochschule für Musik und Theater München
Project management: Ulrich Kaiser