72 lines
2.9 KiB
TypeScript
72 lines
2.9 KiB
TypeScript
import { type Editor } from "./main";
|
|
import { introduction } from "./documentation/introduction";
|
|
import { samples } from "./documentation/samples";
|
|
import { chaining } from "./documentation/chaining";
|
|
import { software_interface } from "./documentation/interface";
|
|
import { time } from "./documentation/time";
|
|
import { midi } from "./documentation/midi";
|
|
import { code } from "./documentation/code";
|
|
import { about } from "./documentation/about";
|
|
import { sound } from "./documentation/engine";
|
|
import { shortcuts } from "./documentation/keyboard";
|
|
import { patterns } from "./documentation/patterns";
|
|
import { functions } from "./documentation/functions";
|
|
import { ziffers } from "./documentation/ziffers";
|
|
import { reference } from "./documentation/reference";
|
|
import { synths } from "./documentation/synths";
|
|
import { bonus } from "./documentation/bonus";
|
|
|
|
export const key_shortcut = (shortcut: string): string => {
|
|
return `<kbd class="lg:px-2 lg:py-1.5 px-1 py-1 lg:text-sm text-xs font-semibold text-gray-800 bg-gray-100 border border-gray-200 rounded-lg dark:bg-gray-600 dark:text-gray-100 dark:border-gray-500">${shortcut}</kbd>`;
|
|
};
|
|
|
|
export const makeExampleFactory = (application: Editor): Function => {
|
|
const make_example = (
|
|
description: string,
|
|
code: string,
|
|
open: boolean = false
|
|
) => {
|
|
const codeId = `codeExample${application.exampleCounter++}`;
|
|
// Store the code snippet in the data structure
|
|
application.api.codeExamples[codeId] = code;
|
|
|
|
return `
|
|
<details ${open ? "open" : ""}>
|
|
<summary >${description}
|
|
<button class="py-1 align-top text-base rounded-lg pl-2 pr-2 hover:bg-green-700 bg-green-600 inline-block" onclick="app.api._playDocExample(app.api.codeExamples['${codeId}'])">▶️ Play</button>
|
|
<button class="py-1 text-base rounded-lg pl-2 pr-2 hover:bg-neutral-600 bg-neutral-500 inline-block pl-2" onclick="app.api._stopDocExample()">⏸️ Pause</button>
|
|
<button class="py-1 text-base rounded-lg pl-2 pr-2 hover:bg-neutral-900 bg-neutral-800 inline-block " onclick="navigator.clipboard.writeText(app.api.codeExamples['${codeId}'])">📎 Copy</button>
|
|
</summary>
|
|
\`\`\`javascript
|
|
${code}
|
|
\`\`\`
|
|
</details>
|
|
`;
|
|
};
|
|
return make_example;
|
|
};
|
|
|
|
export const documentation_factory = (application: Editor) => {
|
|
// Initialize a data structure to store code examples by their unique IDs
|
|
application.api.codeExamples = {};
|
|
|
|
return {
|
|
introduction: introduction(application),
|
|
interface: software_interface(application),
|
|
code: code(application),
|
|
time: time(application),
|
|
sound: sound(application),
|
|
samples: samples(application),
|
|
synths: synths(application),
|
|
chaining: chaining(application),
|
|
patterns: patterns(application),
|
|
ziffers: ziffers(application),
|
|
midi: midi(application),
|
|
functions: functions(application),
|
|
reference: reference(),
|
|
shortcuts: shortcuts(),
|
|
bonus: bonus(application),
|
|
about: about(),
|
|
};
|
|
};
|