diff --git a/src/Documentation.ts b/src/Documentation.ts index 5c2128b..63874d6 100644 --- a/src/Documentation.ts +++ b/src/Documentation.ts @@ -1,11 +1,15 @@ import { type Editor } from "./main"; +// Basics import { introduction } from "./documentation/basics/welcome"; import { software_interface } from "./documentation/basics/interface"; import { shortcuts } from "./documentation/basics/keyboard"; import { code } from "./documentation/basics/code"; import { mouse } from "./documentation/basics/mouse"; -import { oscilloscope } from "./documentation/oscilloscope"; -import { synchronisation } from "./documentation/synchronisation"; +// More +import { oscilloscope } from "./documentation/more/oscilloscope"; +import { synchronisation } from "./documentation/more/synchronisation"; +import { about } from "./documentation/more/about"; +import { bonus } from "./documentation/more/bonus"; import { samples } from "./documentation/samples"; import { chaining } from "./documentation/chaining"; import { interaction } from "./documentation/interaction"; @@ -14,7 +18,6 @@ import { linear_time } from "./documentation/time/linear_time"; import { cyclical_time } from "./documentation/time/cyclical_time"; import { long_forms } from "./documentation/long_forms"; import { midi } from "./documentation/midi"; -import { about } from "./documentation/about"; import { sound } from "./documentation/engine"; import { patterns } from "./documentation/patterns"; import { functions } from "./documentation/functions"; @@ -24,7 +27,6 @@ import { lfos } from "./documentation/lfos"; import { ziffers } from "./documentation/ziffers"; import { reference } from "./documentation/reference"; import { synths } from "./documentation/synths"; -import { bonus } from "./documentation/bonus"; // Setting up the Markdown converter with syntax highlighting import showdown from "showdown"; diff --git a/src/documentation/about.ts b/src/documentation/more/about.ts similarity index 100% rename from src/documentation/about.ts rename to src/documentation/more/about.ts diff --git a/src/documentation/bonus.ts b/src/documentation/more/bonus.ts similarity index 96% rename from src/documentation/bonus.ts rename to src/documentation/more/bonus.ts index 193b56d..f3901b6 100644 --- a/src/documentation/bonus.ts +++ b/src/documentation/more/bonus.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { key_shortcut, makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../main"; +import { key_shortcut, makeExampleFactory } from "../../Documentation"; export const bonus = (application: Editor): string => { const makeExample = makeExampleFactory(application); diff --git a/src/documentation/oscilloscope.ts b/src/documentation/more/oscilloscope.ts similarity index 88% rename from src/documentation/oscilloscope.ts rename to src/documentation/more/oscilloscope.ts index 4c7eea0..b75cf3d 100644 --- a/src/documentation/oscilloscope.ts +++ b/src/documentation/more/oscilloscope.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../main"; +import { makeExampleFactory } from "../../Documentation"; export const oscilloscope = (application: Editor): string => { const makeExample = makeExampleFactory(application); @@ -8,8 +8,8 @@ export const oscilloscope = (application: Editor): string => { You can turn on the oscilloscope to generate interesting visuals or to inspect audio. Use the scope() function to turn it on and off. The oscilloscope is off by default. ${makeExample( - "Oscilloscope configuration", - ` + "Oscilloscope configuration", + ` scope({ enabled: true, // off by default color: "#fdba74", // any valid CSS color or "random" @@ -23,12 +23,12 @@ scope({ refresh: 1 // refresh rate (in pulses) }) `, - true -)} + true + )} ${makeExample( - "Demo with multiple scope mode", - ` + "Demo with multiple scope mode", + ` rhythm(.5, [4,5].dur(4*3, 4*1), 8)::sound('fhardkick').out() beat(0.25)::sound('square').freq([ [250, 250/2, 250/4].pick(), @@ -44,8 +44,8 @@ scope({enabled: true, thickness: 8, color: ['purple', 'green', 'random'].beat(), size: 0.5, fftSize: 2048}) `, - true -)} + true + )} Note that these values can be patterned as well! You can transform the oscilloscope into its own light show if you want. The picture is not stable anyway so you won't have much use of it for precision work :) diff --git a/src/documentation/synchronisation.ts b/src/documentation/more/synchronisation.ts similarity index 93% rename from src/documentation/synchronisation.ts rename to src/documentation/more/synchronisation.ts index 78ee462..b2a7db8 100644 --- a/src/documentation/synchronisation.ts +++ b/src/documentation/more/synchronisation.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../main"; +import { makeExampleFactory } from "../../Documentation"; export const synchronisation = (app: Editor): string => { // @ts-ignore