Moved doc files to same structure as in index
This commit is contained in:
@ -1,13 +1,13 @@
|
|||||||
import { type Editor } from "./main";
|
import { type Editor } from "./main";
|
||||||
// Basics
|
// Basics
|
||||||
import { introduction } from "./documentation/basics/welcome";
|
import { introduction } from "./documentation/basics/welcome";
|
||||||
import { loading_samples } from "./documentation/samples/loading_samples";
|
import { loading_samples } from "./documentation/learning/samples/loading_samples";
|
||||||
import { amplitude } from "./documentation/audio_engine/amplitude";
|
import { amplitude } from "./documentation/learning/audio_engine/amplitude";
|
||||||
import { reverb } from "./documentation/audio_engine/reverb_delay";
|
import { reverb } from "./documentation/learning/audio_engine/reverb_delay";
|
||||||
import { sampler } from "./documentation/audio_engine/sampler";
|
import { sampler } from "./documentation/learning/audio_engine/sampler";
|
||||||
import { sample_banks } from "./documentation/samples/sample_banks";
|
import { sample_banks } from "./documentation/learning/samples/sample_banks";
|
||||||
import { audio_basics } from "./documentation/audio_engine/audio_basics";
|
import { audio_basics } from "./documentation/learning/audio_engine/audio_basics";
|
||||||
import { sample_list } from "./documentation/samples/sample_list";
|
import { sample_list } from "./documentation/learning/samples/sample_list";
|
||||||
import { software_interface } from "./documentation/basics/interface";
|
import { software_interface } from "./documentation/basics/interface";
|
||||||
import { shortcuts } from "./documentation/basics/keyboard";
|
import { shortcuts } from "./documentation/basics/keyboard";
|
||||||
import { code } from "./documentation/basics/code";
|
import { code } from "./documentation/basics/code";
|
||||||
@ -17,20 +17,20 @@ import { oscilloscope } from "./documentation/more/oscilloscope";
|
|||||||
import { synchronisation } from "./documentation/more/synchronisation";
|
import { synchronisation } from "./documentation/more/synchronisation";
|
||||||
import { about } from "./documentation/more/about";
|
import { about } from "./documentation/more/about";
|
||||||
import { bonus } from "./documentation/more/bonus";
|
import { bonus } from "./documentation/more/bonus";
|
||||||
import { chaining } from "./documentation/chaining";
|
import { chaining } from "./documentation/patterns/chaining";
|
||||||
import { interaction } from "./documentation/interaction";
|
import { interaction } from "./documentation/basics/interaction";
|
||||||
import { time } from "./documentation/time/time";
|
import { time } from "./documentation/learning/time/time";
|
||||||
import { linear_time } from "./documentation/time/linear_time";
|
import { linear_time } from "./documentation/learning/time/linear_time";
|
||||||
import { cyclical_time } from "./documentation/time/cyclical_time";
|
import { cyclical_time } from "./documentation/learning/time/cyclical_time";
|
||||||
import { long_forms } from "./documentation/long_forms";
|
import { long_forms } from "./documentation/learning/time/long_forms";
|
||||||
import { midi } from "./documentation/midi";
|
import { midi } from "./documentation/learning/midi";
|
||||||
import { osc } from "./documentation/osc";
|
import { osc } from "./documentation/learning/osc";
|
||||||
import { sound } from "./documentation/engine";
|
import { sound } from "./documentation/engine";
|
||||||
import { patterns } from "./documentation/patterns";
|
import { patterns } from "./documentation/patterns/patterns";
|
||||||
import { functions } from "./documentation/functions";
|
import { functions } from "./documentation/patterns/functions";
|
||||||
import { variables } from "./documentation/variables";
|
import { variables } from "./documentation/patterns/variables";
|
||||||
import { probabilities } from "./documentation/probabilities";
|
import { probabilities } from "./documentation/patterns/probabilities";
|
||||||
import { lfos } from "./documentation/lfos";
|
import { lfos } from "./documentation/patterns/lfos";
|
||||||
import { ziffers_basics } from "./documentation/patterns/ziffers/ziffers_basics";
|
import { ziffers_basics } from "./documentation/patterns/ziffers/ziffers_basics";
|
||||||
import { ziffers_scales } from "./documentation/patterns/ziffers/ziffers_scales";
|
import { ziffers_scales } from "./documentation/patterns/ziffers/ziffers_scales";
|
||||||
import { ziffers_rhythm } from "./documentation/patterns/ziffers/ziffers_rhythm";
|
import { ziffers_rhythm } from "./documentation/patterns/ziffers/ziffers_rhythm";
|
||||||
@ -38,7 +38,7 @@ import { ziffers_algorithmic } from "./documentation/patterns/ziffers/ziffers_al
|
|||||||
|
|
||||||
import { ziffers_tonnetz } from "./documentation/patterns/ziffers/ziffers_tonnetz";
|
import { ziffers_tonnetz } from "./documentation/patterns/ziffers/ziffers_tonnetz";
|
||||||
|
|
||||||
import { synths } from "./documentation/synths";
|
import { synths } from "./documentation/learning/audio_engine/synths";
|
||||||
|
|
||||||
// Setting up the Markdown converter with syntax highlighting
|
// Setting up the Markdown converter with syntax highlighting
|
||||||
import showdown from "showdown";
|
import showdown from "showdown";
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../main";
|
import { type Editor } from "../../main";
|
||||||
import { makeExampleFactory } from "../Documentation";
|
import { makeExampleFactory } from "../../Documentation";
|
||||||
|
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
export const interaction = (application: Editor): string => {
|
export const interaction = (application: Editor): string => {
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
|
|
||||||
export const amplitude = (application: Editor): string => {
|
export const amplitude = (application: Editor): string => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
|
|
||||||
export const audio_basics = (application: Editor): string => {
|
export const audio_basics = (application: Editor): string => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
|
|
||||||
export const distortion = (application: Editor): string => {
|
export const distortion = (application: Editor): string => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
|
|
||||||
export const reverb = (application: Editor): string => {
|
export const reverb = (application: Editor): string => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
|
|
||||||
export const sampler = (application: Editor): string => {
|
export const sampler = (application: Editor): string => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
|
|
||||||
export const synths = (application: Editor): string => {
|
export const synths = (application: Editor): string => {
|
||||||
const makeExample = makeExampleFactory(application);
|
const makeExample = makeExampleFactory(application);
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../main";
|
import { type Editor } from "../../main";
|
||||||
import { makeExampleFactory, key_shortcut } from "../Documentation";
|
import { makeExampleFactory, key_shortcut } from "../../Documentation";
|
||||||
|
|
||||||
export const midi = (application: Editor): string => {
|
export const midi = (application: Editor): string => {
|
||||||
const makeExample = makeExampleFactory(application);
|
const makeExample = makeExampleFactory(application);
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../main";
|
import { type Editor } from "../../main";
|
||||||
import { makeExampleFactory } from "../Documentation";
|
import { makeExampleFactory } from "../../Documentation";
|
||||||
|
|
||||||
export const osc = (application: Editor): string => {
|
export const osc = (application: Editor): string => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
|
|
||||||
export const loading_samples = (application: Editor): string => {
|
export const loading_samples = (application: Editor): string => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
|
|
||||||
export const sample_banks = (application: Editor): string => {
|
export const sample_banks = (application: Editor): string => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
|
|
||||||
export const samples_to_markdown = (
|
export const samples_to_markdown = (
|
||||||
application: Editor,
|
application: Editor,
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
|
|
||||||
export const cyclical_time = (app: Editor): string => {
|
export const cyclical_time = (app: Editor): string => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
import pulses from "./pulses.svg";
|
import pulses from "./pulses.svg";
|
||||||
|
|
||||||
export const linear_time = (app: Editor): string => {
|
export const linear_time = (app: Editor): string => {
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../main";
|
import { type Editor } from "../../../main";
|
||||||
import { makeExampleFactory } from "../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
|
|
||||||
export const long_forms = (app: Editor): string => {
|
export const long_forms = (app: Editor): string => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
|
Before Width: | Height: | Size: 8.4 KiB After Width: | Height: | Size: 8.4 KiB |
@ -1,5 +1,5 @@
|
|||||||
import { makeExampleFactory } from "../../Documentation";
|
import { makeExampleFactory } from "../../../Documentation";
|
||||||
import { type Editor } from "../../main";
|
import { type Editor } from "../../../main";
|
||||||
import times from "./times.svg";
|
import times from "./times.svg";
|
||||||
|
|
||||||
export const time = (application: Editor): string => {
|
export const time = (application: Editor): string => {
|
||||||
|
Before Width: | Height: | Size: 5.0 KiB After Width: | Height: | Size: 5.0 KiB |
@ -1,5 +1,5 @@
|
|||||||
import { makeExampleFactory } from "../Documentation";
|
import { makeExampleFactory } from "../../Documentation";
|
||||||
import { type Editor } from "../main";
|
import { type Editor } from "../../main";
|
||||||
|
|
||||||
export const chaining = (application: Editor): string => {
|
export const chaining = (application: Editor): string => {
|
||||||
const makeExample = makeExampleFactory(application);
|
const makeExample = makeExampleFactory(application);
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../main";
|
import { type Editor } from "../../main";
|
||||||
import { makeExampleFactory } from "../Documentation";
|
import { makeExampleFactory } from "../../Documentation";
|
||||||
|
|
||||||
export const functions = (application: Editor): string => {
|
export const functions = (application: Editor): string => {
|
||||||
const makeExample = makeExampleFactory(application);
|
const makeExample = makeExampleFactory(application);
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../main";
|
import { type Editor } from "../../main";
|
||||||
import { makeExampleFactory } from "../Documentation";
|
import { makeExampleFactory } from "../../Documentation";
|
||||||
|
|
||||||
export const lfos = (application: Editor): string => {
|
export const lfos = (application: Editor): string => {
|
||||||
const makeExample = makeExampleFactory(application);
|
const makeExample = makeExampleFactory(application);
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../main";
|
import { type Editor } from "../../main";
|
||||||
import { makeExampleFactory } from "../Documentation";
|
import { makeExampleFactory } from "../../Documentation";
|
||||||
|
|
||||||
export const patterns = (application: Editor): string => {
|
export const patterns = (application: Editor): string => {
|
||||||
const makeExample = makeExampleFactory(application);
|
const makeExample = makeExampleFactory(application);
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../main";
|
import { type Editor } from "../../main";
|
||||||
import { makeExampleFactory } from "../Documentation";
|
import { makeExampleFactory } from "../../Documentation";
|
||||||
|
|
||||||
export const probabilities = (application: Editor): string => {
|
export const probabilities = (application: Editor): string => {
|
||||||
const makeExample = makeExampleFactory(application);
|
const makeExample = makeExampleFactory(application);
|
||||||
@ -1,5 +1,5 @@
|
|||||||
import { type Editor } from "../main";
|
import { type Editor } from "../../main";
|
||||||
import { makeExampleFactory } from "../Documentation";
|
import { makeExampleFactory } from "../../Documentation";
|
||||||
|
|
||||||
export const variables = (application: Editor): string => {
|
export const variables = (application: Editor): string => {
|
||||||
const makeExample = makeExampleFactory(application);
|
const makeExample = makeExampleFactory(application);
|
||||||
@ -6,7 +6,7 @@ export const ziffers_scales = (application: Editor): string => {
|
|||||||
return `
|
return `
|
||||||
# Scales
|
# Scales
|
||||||
|
|
||||||
Ziffers supports all the keys and scales. Keys can be defined by using [scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation), for example <ic>F3</ic>. Western style (1490 scales) can be with scale names named after greek modes and extended by [William Zeitler](https://ianring.com/musictheory/scales/traditions/zeitler). You will never really run out of scales to play with using Ziffers. Here is a short list of some possible scales that you can play with:
|
Ziffers supports all the keys and scales. Keys can be defined by using [scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation), for example <ic>F3</ic>. Western style (1490 scales) can be with scale names named after greek modes and extended by <a href="https://allthescales.org/intro.php" target="_blank">William Zeitler</a>. You will never really run out of scales to play with using Ziffers. Here is a short list of some possible scales that you can play with:
|
||||||
|
|
||||||
| Scale name | Intervals |
|
| Scale name | Intervals |
|
||||||
|------------|------------------------|
|
|------------|------------------------|
|
||||||
@ -20,7 +20,7 @@ export const ziffers_scales = (application: Editor): string => {
|
|||||||
| Soryllic | <ic>11122122</ic>|
|
| Soryllic | <ic>11122122</ic>|
|
||||||
| Modimic | <ic>412122</ic> |
|
| Modimic | <ic>412122</ic> |
|
||||||
| Ionalian | <ic>1312122</ic> |
|
| Ionalian | <ic>1312122</ic> |
|
||||||
| ... | And it goes on for **1490** scales |
|
| ... | And it goes on for <a href="https://ianring.com/musictheory/scales/traditions/zeitler" target="_blank">**1490** scales (See full list here)</a>. |
|
||||||
|
|
||||||
${makeExample(
|
${makeExample(
|
||||||
"What the hell is the Modimic scale?",
|
"What the hell is the Modimic scale?",
|
||||||
@ -33,7 +33,7 @@ export const ziffers_scales = (application: Editor): string => {
|
|||||||
`,
|
`,
|
||||||
true,
|
true,
|
||||||
)}
|
)}
|
||||||
|
|
||||||
You can also use more traditional <a href="https://ianring.com/musictheory/scales/traditions/western" target="_blank">western names</a>:
|
You can also use more traditional <a href="https://ianring.com/musictheory/scales/traditions/western" target="_blank">western names</a>:
|
||||||
|
|
||||||
| Scale name | Intervals |
|
| Scale name | Intervals |
|
||||||
|
|||||||
Reference in New Issue
Block a user