diff --git a/docs/docs/configuration/configuration-object.md b/docs/docs/configuration/configuration-object.md index b3fd334de..7f8f1fe46 100644 --- a/docs/docs/configuration/configuration-object.md +++ b/docs/docs/configuration/configuration-object.md @@ -55,7 +55,7 @@ These are properties that define the content of the current [project](../feature ### `title` -Type: [`string`](../api/interfaces/Config#title) +Type: [`string`](../api/interfaces/Config.md#title) Default: `"Untitled Project"` @@ -63,7 +63,7 @@ Project title. This is used as [result page](../features/result.md) title. ### `description` -Type: [`string`](../api/interfaces/Config#description) +Type: [`string`](../api/interfaces/Config.md#description) Default: `""` @@ -71,7 +71,7 @@ Project description. Used in [project](../features/projects.md) search. This can ### `tags` -Type: [`string[]`](../api/interfaces/Config#tags) +Type: [`string[]`](../api/interfaces/Config.md#tags) Default: `[]` @@ -79,7 +79,7 @@ Project tags. Used in [project](../features/projects.md) filter and search. This ### `activeEditor` -Type: [`"markup" | "style" | "script" | undefined`](../api/interfaces/Config#activeeditor) +Type: [`"markup" | "style" | "script" | undefined`](../api/interfaces/Config.md#activeeditor) Default: Last used editor for user, otherwise "markup" @@ -87,7 +87,7 @@ Selects the active editor to show. ### `languages` -Type: [`Language[] | undefined`](../api/interfaces/Config#languages) +Type: [`Language[] | undefined`](../api/interfaces/Config.md#languages) Default: all supported languages in full app and only current editor languages in [embeds](../features/embeds.md). @@ -97,31 +97,31 @@ List of enabled languages. Languages that are not already loaded in the editors ### `markup` -Type: [`Editor`](../api/interfaces/internal.Editor) +Type: [`Editor`](../api/interfaces/internal.Editor.md) Default: `{ language: 'html', content: '' }` -Configures the [language](../api/modules/internal#language) and content of the markup editor. +Configures the [language](../api/modules/internal.md#language) and content of the markup editor. ### `style` -Type: [`Editor`](../api/interfaces/internal.Editor) +Type: [`Editor`](../api/interfaces/internal.Editor.md) Default: `{ language: 'css', content: '' }` -Configures the [language](../api/modules/internal#language) and content of the style editor. +Configures the [language](../api/modules/internal.md#language) and content of the style editor. ### `script` -Type: [`Editor`](../api/interfaces/internal.Editor) +Type: [`Editor`](../api/interfaces/internal.Editor.md) Default: `{ language: 'javascript', content: '' }` -Configures the [language](../api/modules/internal#language) and content of the script editor. +Configures the [language](../api/modules/internal.md#language) and content of the script editor. ### `stylesheets` -Type: [`string[]`](../api/interfaces/Config#stylesheets) +Type: [`string[]`](../api/interfaces/Config.md#stylesheets) Default: `[]` @@ -129,7 +129,7 @@ List of URLs for [external stylesheets](../features/external-resources.md) to ad ### `scripts` -Type: [`string[]`](../api/interfaces/Config#scripts) +Type: [`string[]`](../api/interfaces/Config.md#scripts) Default: `[]` @@ -220,7 +220,7 @@ When bare module imports are encountered, LiveCodes adds an import map to the re ### `types` -Type: [`[key: string]: string | { autoload?: boolean ; declareAsModule?: boolean ; url: string }`](../api/interfaces/internal.Types) +Type: [`[key: string]: string | { autoload?: boolean ; declareAsModule?: boolean ; url: string }`](../api/interfaces/internal.Types.md) Default: `{}` @@ -270,7 +270,7 @@ Example: ### `tests` -Type: `undefined` | `Partial`<[`Editor`](../api/interfaces/internal.Editor)> +Type: `undefined` | `Partial`<[`Editor`](../api/interfaces/internal.Editor.md)> Default: `{ language: 'typescript', content: '' }` @@ -278,7 +278,7 @@ Configures the [language](../features/tests.md#supported-languages) and content ### `version` -Type: `Readonly` [`string`](../api/interfaces/Config#description) +Type: `Readonly` [`string`](../api/interfaces/Config.md#description) Default: Current LiveCodes Version. @@ -297,7 +297,7 @@ These are properties that define how the app behaves. ### `readonly` -Type: [`boolean`](../api/interfaces/Config#readonly) +Type: [`boolean`](../api/interfaces/Config.md#readonly) Default: `false` @@ -307,7 +307,7 @@ By default, when `readonly` is set to `true`, the light-weight code editor [Code ### `allowLangChange` -Type: [`boolean`](../api/interfaces/Config#allowlangchange) +Type: [`boolean`](../api/interfaces/Config.md#allowlangchange) Default: `true` @@ -315,7 +315,7 @@ If `false`, the UI will not show the menu that allows changing editor language. ### `mode` -Type: [`"full" | "result" | "editor" | "codeblock"`](../api/interfaces/Config#mode) +Type: [`"full" | "result" | "editor" | "codeblock"`](../api/interfaces/Config.md#mode) Default: `"full"` @@ -323,7 +323,7 @@ Sets [display mode](../features/display-modes.md) ### `tools` -Type: [`{ enabled: Array<'console' | 'compiled' | 'tests'> | 'all'; active: 'console' | 'compiled' | 'tests' | ''; status: 'closed' | 'open' | 'full' | 'none' | ''; }`](../api/interfaces/Config#tools) +Type: [`{ enabled: Array<'console' | 'compiled' | 'tests'> | 'all'; active: 'console' | 'compiled' | 'tests' | ''; status: 'closed' | 'open' | 'full' | 'none' | ''; }`](../api/interfaces/Config.md#tools) Default: `{ enabled: 'all', active: '', status: '' }` @@ -345,7 +345,7 @@ Example: ### `zoom` -Type: [`1 | 0.5 | 0.25`](../api/interfaces/Config#zoom) +Type: [`1 | 0.5 | 0.25`](../api/interfaces/Config.md#zoom) Default: `1` @@ -357,7 +357,7 @@ These are properties that define the [user settings](./../features/user-settings ### `autoupdate` -Type: [`boolean`](../api/interfaces/Config#autoupdate) +Type: [`boolean`](../api/interfaces/Config.md#autoupdate) Default: `true` @@ -365,7 +365,7 @@ If `true`, the result page is automatically updated on code change, after time [ ### `autosave` -Type: [`boolean`](../api/interfaces/Config#autosave) +Type: [`boolean`](../api/interfaces/Config.md#autosave) Default: `false` @@ -373,7 +373,7 @@ If `true`, the project is automatically saved on code change, after time [delay] ### `delay` -Type: [`number`](../api/interfaces/Config#delay) +Type: [`number`](../api/interfaces/Config.md#delay) Default: `1500` @@ -381,7 +381,7 @@ Time delay (in milliseconds) follwing code change, after which the result page i ### `formatOnsave` -Type: [`boolean`](../api/interfaces/Config#formatonsave) +Type: [`boolean`](../api/interfaces/Config.md#formatonsave) Default: `false` @@ -389,7 +389,7 @@ If `true`, the code is automatically [formatted](../features/code-format.md) on ### `theme` -Type: [`"light" | "dark"`](../api/interfaces/Config#theme) +Type: [`"light" | "dark"`](../api/interfaces/Config.md#theme) Default: `"dark"` @@ -397,7 +397,7 @@ Sets the app [theme](../features/themes.md). ### `recoverUnsaved` -Type: [`boolean`](../api/interfaces/Config#recoverunsaved) +Type: [`boolean`](../api/interfaces/Config.md#recoverunsaved) Default: `true` @@ -405,7 +405,7 @@ Enables [recovering last unsaved project](../features/recover.md) when the app i ### `showSpacing` -Type: [`boolean`](../api/interfaces/Config#showspacing) +Type: [`boolean`](../api/interfaces/Config.md#showspacing) Default: `false` @@ -413,7 +413,7 @@ Enables [showing element spacing](../features/result.md#show-spacings) in the re ### `editor` -Type: [`"monaco" | "codemirror" | "codejar" | undefined`](../api/interfaces/Config#editor) +Type: [`"monaco" | "codemirror" | "codejar" | undefined`](../api/interfaces/Config.md#editor) Default: `undefined` @@ -423,7 +423,7 @@ If `undefined` (the default), Monaco editor is used on desktop, CodeMirror is us ### `fontFamily` -Type: [`string | undefined`](../api/interfaces/Config#fontfamily) +Type: [`string | undefined`](../api/interfaces/Config.md#fontfamily) Default: `undefined` @@ -431,7 +431,7 @@ Sets the [code editor](../features/editor-settings.md) font family. ### `fontSize` -Type: [`number | undefined`](../api/interfaces/Config#fontfamily) +Type: [`number | undefined`](../api/interfaces/Config.md#fontfamily) Default: `undefined` @@ -441,7 +441,7 @@ If `undefined` (the default), the font size is set to 14 for the full app and 12 ### `useTabs` -Type: [`boolean`](../api/interfaces/Config#usetabs) +Type: [`boolean`](../api/interfaces/Config.md#usetabs) Default: `false` @@ -449,7 +449,7 @@ If `true`, lines are indented with tabs instead of spaces. Also used in [code fo ### `tabSize` -Type: [`number`](../api/interfaces/Config#tabsize) +Type: [`number`](../api/interfaces/Config.md#tabsize) Default: `2` @@ -457,7 +457,7 @@ The number of spaces per indentation-level. Also used in [code formatting](../fe ### `lineNumbers` -Type: [`boolean`](../api/interfaces/Config#linenumbers) +Type: [`boolean`](../api/interfaces/Config.md#linenumbers) Default: `true` @@ -465,7 +465,7 @@ Show line numbers in [code editor](../features/editor-settings.md). ### `wordWrap` -Type: [`boolean`](../api/interfaces/Config#wordwrap) +Type: [`boolean`](../api/interfaces/Config.md#wordwrap) Default: `false` @@ -473,7 +473,7 @@ Enables word-wrap for long lines. ### `closeBrackets` -Type: [`boolean`](../api/interfaces/Config#closebrackets) +Type: [`boolean`](../api/interfaces/Config.md#closebrackets) Default: `true` @@ -481,7 +481,7 @@ Use auto-complete to close brackets and quotes. ### `emmet` -Type: [`boolean`](../api/interfaces/Config#emmet) +Type: [`boolean`](../api/interfaces/Config.md#emmet) Default: `true` @@ -489,7 +489,7 @@ Enables [emmet](../features/editor-settings.md#emmet). ### `editorMode` -Type: [`"vim" | "emacs" | undefined`](../api/interfaces/Config#editormode) +Type: [`"vim" | "emacs" | undefined`](../api/interfaces/Config.md#editormode) Default: `undefined` @@ -497,7 +497,7 @@ Sets [editor mode](../features/editor-settings.md#editor-modes). ### `semicolons` -Type: [`boolean`](../api/interfaces/Config#semicolons) +Type: [`boolean`](../api/interfaces/Config.md#semicolons) Default: `true` @@ -505,7 +505,7 @@ Configures Prettier [code formatter](../features/code-format.md) to use [semi-co ### `singleQuote` -Type: [`boolean`](../api/interfaces/Config#singlequote) +Type: [`boolean`](../api/interfaces/Config.md#singlequote) Default: `false` @@ -513,7 +513,7 @@ Configures Prettier [code formatter](../features/code-format.md) to use [single ### `trailingComma` -Type: [`boolean`](../api/interfaces/Config#trailingcomma) +Type: [`boolean`](../api/interfaces/Config.md#trailingcomma) Default: `true` diff --git a/docs/docs/configuration/query-params.md b/docs/docs/configuration/query-params.md index 748182ead..92b839c1b 100644 --- a/docs/docs/configuration/query-params.md +++ b/docs/docs/configuration/query-params.md @@ -103,15 +103,15 @@ https://livecodes.io?js=console.log('Hello World!')&console=open Alias to [`import`](../sdk/js-ts.md#import) (a URL to [import](../features/import.md)). - - `raw`: [`Language`](../api/modules/internal#language). + - `raw`: [`Language`](../api/modules/internal.md#language). When used with `import` or `x`, imports the URL as code of the provided language. - - `language`: [`Language`](../api/modules/internal#language). + - `language`: [`Language`](../api/modules/internal.md#language). The language to load by default in the editor. - - `lang`: [`Language`](../api/modules/internal#language). + - `lang`: [`Language`](../api/modules/internal.md#language). Alias to `language`. @@ -139,7 +139,7 @@ https://livecodes.io?js=console.log('Hello World!')&console=open If `false`, the [result page](../features/result.md) [scroll position](../features/result.md#scroll-position) will not be maintained after reload. - - Any [`Language`](../api/modules/internal#language) can used as a query parameter, and the value will be used as its code. + - Any [`Language`](../api/modules/internal.md#language) can used as a query parameter, and the value will be used as its code. Example: diff --git a/docs/docs/features/ai.md b/docs/docs/features/ai.md index 02a59c8ea..91a161922 100644 --- a/docs/docs/features/ai.md +++ b/docs/docs/features/ai.md @@ -4,7 +4,7 @@ LiveCodes supports AI-powered code completion, totally for **free**, using [Code The large generative machine learning model is capable of understanding the context of your code and comments in order to generate suggestions on what you might want to type next. -It has a wide range of language support, and it works everywhere (in the [standalone app](../getting-started#standalone-app), [embedded playgrounds](./embeds) and [self-hosted](./self-hosting) apps). +It has a wide range of language support, and it works everywhere (in the [standalone app](../getting-started.md#standalone-app), [embedded playgrounds](./embeds.md) and [self-hosted](./self-hosting.md) apps). ## Examples: diff --git a/docs/docs/features/code-format.md b/docs/docs/features/code-format.md index c7fe519ac..1d900633a 100644 --- a/docs/docs/features/code-format.md +++ b/docs/docs/features/code-format.md @@ -1,10 +1,10 @@ # Code Format -Code formatting is supported for most [languages](../languages/). +Code formatting is supported for most [languages](../languages/index.md). ## Code Formatters -The code formatter used for each language is specified in the [language documentation](../languages/) page. +The code formatter used for each language is specified in the [language documentation](../languages/index.md) page. For example: @@ -49,4 +49,4 @@ Code format can be configured using the [configuration object](../configuration/ ## SDK Method: `format` -The code format can be programmatically triggered by the [SDK](../sdk/) method [`format`](../sdk/js-ts.md#format). +The code format can be programmatically triggered by the [SDK](../sdk/index.md) method [`format`](../sdk/js-ts.md#format). diff --git a/docs/docs/features/code-prefill.md b/docs/docs/features/code-prefill.md index 5b83a329d..458130101 100644 --- a/docs/docs/features/code-prefill.md +++ b/docs/docs/features/code-prefill.md @@ -58,5 +58,5 @@ TODO... - [Import](./import.md) - [Templates](./templates.md) -- [Configuration](../configuration/) -- [SDK](../sdk/) +- [Configuration](../configuration/index.md) +- [SDK](../sdk/index.md) diff --git a/docs/docs/features/default-template-language.md b/docs/docs/features/default-template-language.md index 010d665e7..e00815fcc 100644 --- a/docs/docs/features/default-template-language.md +++ b/docs/docs/features/default-template-language.md @@ -1,6 +1,6 @@ # Default Template/Language -When the app is loaded, by default, the last used [language](../languages/) is selected. +When the app is loaded, by default, the last used [language](../languages/index.md) is selected. The app can also be configured to load a default [user template](./templates.md#user-templates). diff --git a/docs/docs/features/embeds.md b/docs/docs/features/embeds.md index 54fd71d67..130658cc5 100644 --- a/docs/docs/features/embeds.md +++ b/docs/docs/features/embeds.md @@ -10,7 +10,7 @@ Demo: -The embedding web page can communicate with the playground using a powerful [SDK](../sdk/) (e.g. edit/format code, watch for code changes, get the compiled code or result page HTML, run tests, change layout, ...etc). +The embedding web page can communicate with the playground using a powerful [SDK](../sdk/index.md) (e.g. edit/format code, watch for code changes, get the compiled code or result page HTML, run tests, change layout, ...etc). ## Create Embedded Playground diff --git a/docs/docs/features/index.md b/docs/docs/features/index.md index a44da20be..22882558f 100644 --- a/docs/docs/features/index.md +++ b/docs/docs/features/index.md @@ -6,7 +6,7 @@ sidebar_class_name: exclude_from_sidebar ## Overview -_LiveCodes_ is an open-source, client-side, code playground that runs in the browser. It enables quick prototyping and experimenting with a wide variety of [technologies](../languages/) (including 80+ languages, frameworks and processors) without having to manually setup a development environment for each. The [result](./result.md) is displayed as a regular web page. The rapid feedback of previewing the result page without waiting for build steps significantly boosts productivity. +_LiveCodes_ is an open-source, client-side, code playground that runs in the browser. It enables quick prototyping and experimenting with a wide variety of [technologies](../languages/index.md) (including 80+ languages, frameworks and processors) without having to manually setup a development environment for each. The [result](./result.md) is displayed as a regular web page. The rapid feedback of previewing the result page without waiting for build steps significantly boosts productivity. ![LiveCodes screenshot](../../static/img/screenshots/features.jpg) @@ -14,7 +14,7 @@ In this page, a quick overview of the important features are presented. A more d ## Powerful Editor -The default code editor is the powerful editor that powers [VS Code](https://code.visualstudio.com/), featuring code-completion, go-to-definition, multi-cursor support and other powerful features you got used to. The editor is very [customizable](./editor-settings.md). It supports [keyboard shortcuts](./keyboard-shortcuts.md), [code formatting](./code-format.md), [Emmet abbreviations](./editor-settings#emmet) and even [Vim and Emacs bindings](./editor-settings.md#editor-modes). +The default code editor is the powerful editor that powers [VS Code](https://code.visualstudio.com/), featuring code-completion, go-to-definition, multi-cursor support and other powerful features you got used to. The editor is very [customizable](./editor-settings.md). It supports [keyboard shortcuts](./keyboard-shortcuts.md), [code formatting](./code-format.md), [Emmet abbreviations](./editor-settings.md#emmet) and even [Vim and Emacs bindings](./editor-settings.md#editor-modes). ## AI Code Assistant @@ -38,7 +38,7 @@ Projects can be easily [shared](./share.md) as URLs or QR codes. In addition, yo ## Embed -Projects can be [embedded](./embeds.md) in any web page. The embed screen allows you to customize the embed options and preview the resulting playground. An easy-to-use, yet powerful, [SDK](../sdk/), that allows [communication](../sdk/js-ts.md#sdk-methods) between the embedding page and the playground. +Projects can be [embedded](./embeds.md) in any web page. The embed screen allows you to customize the embed options and preview the resulting playground. An easy-to-use, yet powerful, [SDK](../sdk/index.md), that allows [communication](../sdk/js-ts.md#sdk-methods) between the embedding page and the playground. ## Deploy @@ -72,11 +72,11 @@ LiveCodes runs in the browser, where all the processing/transpilation occurs, wi ## Developer-friendly -LiveCodes makes it easy to [get started](../getting-started). It is highly [configurable](../configuration). Lots of features can be configured by URL [query params](../configuration/query-params). The [SDK](../sdk/) facilitates [embedding](./embeds.md) playgrounds and allows easy [communication](../sdk/js-ts#sdk-methods) with them. The SDK is available for use in [JS/TS](../sdk/js-ts.md), [React](../sdk/react.md) [Vue](../sdk/vue.md) and [Svelte](../sdk/svelte.md). +LiveCodes makes it easy to [get started](../getting-started.md). It is highly [configurable](../configuration/index.md). Lots of features can be configured by URL [query params](../configuration/query-params.md). The [SDK](../sdk/index.md) facilitates [embedding](./embeds.md) playgrounds and allows easy [communication](../sdk/js-ts.md#sdk-methods) with them. The SDK is available for use in [JS/TS](../sdk/js-ts.md), [React](../sdk/react.md) [Vue](../sdk/vue.md) and [Svelte](../sdk/svelte.md). ## Comprehensive Documentations -Rich documentations with screenshots, code samples and live demos are available. They cover the app [features](../features/), [configuration](../configuration/), [supported languages](../languages/) and [SDK](../sdk/) (including [TypeScript Types](../api/modules)). A gallery of usage examples is provided as a [storybook](pathname:///../stories). +Rich documentations with screenshots, code samples and live demos are available. They cover the app [features](../features/index.md), [configuration](../configuration/index.md), [supported languages](../languages/index.md) and [SDK](../sdk/index.md) (including [TypeScript Types](../api/modules.md)). A gallery of usage examples is provided as a [storybook](pathname:///../stories). ## Focused on Privacy diff --git a/docs/docs/features/permanent-url.md b/docs/docs/features/permanent-url.md index b90fa1edb..33316429d 100644 --- a/docs/docs/features/permanent-url.md +++ b/docs/docs/features/permanent-url.md @@ -23,7 +23,7 @@ This allows [embedded playgrounds](./embeds.md) to use a pinned version of the L Permanent URL is used by default in the code generated by the [embed screen UI](./embeds.md). It is also available when [sharing](./share.md) projects from the share screen. -The [SDK](../sdk/) embed option [`appUrl`](../sdk/js-ts#appurl) allows specifying the URL for the app to be used. +The [SDK](../sdk/index.md) embed option [`appUrl`](../sdk/js-ts.md#appurl) allows specifying the URL for the app to be used. In addition, it is always a good practice to use a specific version of the SDK. Example: @@ -121,5 +121,5 @@ ${' '}}); - [Embedded playgrounds](./embeds.md) - [Share](./share.md) -- [SDK](../sdk/) +- [SDK](../sdk/index.md) - [`exec` SDK method](../sdk/js-ts.md#exec) diff --git a/docs/docs/features/projects.md b/docs/docs/features/projects.md index 8bbfaa5cd..b609a157b 100644 --- a/docs/docs/features/projects.md +++ b/docs/docs/features/projects.md @@ -30,7 +30,7 @@ These are either: - Languages that are interpreted by a JavaScript runtime (e.g. PHP - interpreted by [Uniter runtime](https://github.com/asmblah/uniter), Scheme - interpreted by [BiwaScheme](https://www.biwascheme.org)) - Languages running in WASM (e.g. Python - [Pyodide](https://pyodide.org/), AssemblyScript). -For the full list of supported languages, check the [Languages section](../languages/). +For the full list of supported languages, check the [Languages section](../languages/index.md). ## Organizing Projects diff --git a/docs/docs/features/result.md b/docs/docs/features/result.md index 77fd402c1..614a2b8d1 100644 --- a/docs/docs/features/result.md +++ b/docs/docs/features/result.md @@ -68,7 +68,7 @@ From the [tools pane](./tools-pane.md), the result page can be viewed in a separ Please note that the URL of the result page shown in the new window is a [temporary URL](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL#parameters), for local preview. Sharing this URL will not work. -If you need to share a project, use the [Share screen](./share). While, if you need to share the result page use the `result` [display mode](./display-modes.md) or the [broadcast](./broadcast.md) feature. +If you need to share a project, use the [Share screen](./share.md). While, if you need to share the result page use the `result` [display mode](./display-modes.md) or the [broadcast](./broadcast.md) feature. ::: diff --git a/docs/docs/features/templates.md b/docs/docs/features/templates.md index bbac7850d..842f9eb66 100644 --- a/docs/docs/features/templates.md +++ b/docs/docs/features/templates.md @@ -12,13 +12,13 @@ A new project (from template) can be started from: ## Starter Templates -A Large number of starter templates are available. They act as starting points and example usage for the [languages](../languages/) available in LiveCodes. +A Large number of starter templates are available. They act as starting points and example usage for the [languages](../languages/index.md) available in LiveCodes. A direct link for a starter template has the following format: `?template={template_name}` (e.g. https://livecodes.io/?template=react) -The list of template names are documented [here](../api/modules/internal#templatename). +The list of template names are documented [here](../api/modules/internal.md#templatename). ### Template List @@ -46,4 +46,4 @@ User templates are scoped to the currently [logged-in user](./user-management.md - [User management](./user-management.md) - [Backup/Restore](./backup-restore.md) - [Sync](./sync.md) -- [Languages](../languages/) +- [Languages](../languages/index.md) diff --git a/docs/docs/features/tests.md b/docs/docs/features/tests.md index 640d75b06..ef7c5e023 100644 --- a/docs/docs/features/tests.md +++ b/docs/docs/features/tests.md @@ -49,7 +49,7 @@ In the tests panel, you can find: Please note that the tests panel are hidden by default in [embedded playgrounds](./embeds.md) unless the [project has tests](../configuration/configuration-object.md#tests). In such case, the panel is added to the [tools pane](./tools-pane.md). However, the test editor is not shown. -The [SDK](../sdk/) can control the visibility of the different tools in the tools pane (see [`tools`](../configuration/configuration-object.md#tools) property of the [configuration object](../configuration/configuration-object.md)). +The [SDK](../sdk/index.md) can control the visibility of the different tools in the tools pane (see [`tools`](../configuration/configuration-object.md#tools) property of the [configuration object](../configuration/configuration-object.md)). The tests panel and the test editor are always shown in the [full standalone app](../getting-started.md#standalone-app). diff --git a/docs/docs/languages/art-template.md b/docs/docs/languages/art-template.md index 797ca0fe9..8ee13dbbe 100644 --- a/docs/docs/languages/art-template.md +++ b/docs/docs/languages/art-template.md @@ -42,7 +42,7 @@ Example: In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the [result page](../features/result.md) runtime. -This can be achieved in JavaScript (or any [language](../languages/) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. +This can be achieved in JavaScript (or any [language](../languages/index.md) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. Please note that template rendering occurs on [page load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event), so the assignment must occur before that. diff --git a/docs/docs/languages/dot.md b/docs/docs/languages/dot.md index 7b4a4faeb..20d29c1a6 100644 --- a/docs/docs/languages/dot.md +++ b/docs/docs/languages/dot.md @@ -42,7 +42,7 @@ Example: In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the [result page](../features/result.md) runtime. -This can be achieved in JavaScript (or any [language](../languages/) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. +This can be achieved in JavaScript (or any [language](../languages/index.md) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. Please note that template rendering occurs on [page load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event), so the assignment must occur before that. diff --git a/docs/docs/languages/ejs.md b/docs/docs/languages/ejs.md index 6bb7a734f..119d98b64 100644 --- a/docs/docs/languages/ejs.md +++ b/docs/docs/languages/ejs.md @@ -42,7 +42,7 @@ Example: In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the [result page](../features/result.md) runtime. -This can be achieved in JavaScript (or any [language](../languages/) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. +This can be achieved in JavaScript (or any [language](../languages/index.md) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. Please note that template rendering occurs on [page load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event), so the assignment must occur before that. diff --git a/docs/docs/languages/eta.md b/docs/docs/languages/eta.md index fe9a71f96..bcc0c55f0 100644 --- a/docs/docs/languages/eta.md +++ b/docs/docs/languages/eta.md @@ -42,7 +42,7 @@ Example: In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the [result page](../features/result.md) runtime. -This can be achieved in JavaScript (or any [language](../languages/) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. +This can be achieved in JavaScript (or any [language](../languages/index.md) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. Please note that template rendering occurs on [page load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event), so the assignment must occur before that. diff --git a/docs/docs/languages/haml.md b/docs/docs/languages/haml.md index 26d035bd4..55a863e59 100644 --- a/docs/docs/languages/haml.md +++ b/docs/docs/languages/haml.md @@ -42,7 +42,7 @@ Example: In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the [result page](../features/result.md) runtime. -This can be achieved in JavaScript (or any [language](../languages/) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. +This can be achieved in JavaScript (or any [language](../languages/index.md) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. Please note that template rendering occurs on [page load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event), so the assignment must occur before that. diff --git a/docs/docs/languages/handlebars.md b/docs/docs/languages/handlebars.md index 4dcf962ea..f2c407187 100644 --- a/docs/docs/languages/handlebars.md +++ b/docs/docs/languages/handlebars.md @@ -42,7 +42,7 @@ Example: In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the [result page](../features/result.md) runtime. -This can be achieved in JavaScript (or any [language](../languages/) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. +This can be achieved in JavaScript (or any [language](../languages/index.md) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. Please note that template rendering occurs on [page load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event), so the assignment must occur before that. diff --git a/docs/docs/languages/liquid.md b/docs/docs/languages/liquid.md index aa8e6c9ae..82f992f9e 100644 --- a/docs/docs/languages/liquid.md +++ b/docs/docs/languages/liquid.md @@ -42,7 +42,7 @@ Example: In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the [result page](../features/result.md) runtime. -This can be achieved in JavaScript (or any [language](../languages/) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. +This can be achieved in JavaScript (or any [language](../languages/index.md) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. Please note that template rendering occurs on [page load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event), so the assignment must occur before that. diff --git a/docs/docs/languages/mustache.md b/docs/docs/languages/mustache.md index b16b784b6..f507c7728 100644 --- a/docs/docs/languages/mustache.md +++ b/docs/docs/languages/mustache.md @@ -42,7 +42,7 @@ Example: In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the [result page](../features/result.md) runtime. -This can be achieved in JavaScript (or any [language](../languages/) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. +This can be achieved in JavaScript (or any [language](../languages/index.md) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. Please note that template rendering occurs on [page load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event), so the assignment must occur before that. diff --git a/docs/docs/languages/nunjucks.md b/docs/docs/languages/nunjucks.md index ef8e38c79..591fc1632 100644 --- a/docs/docs/languages/nunjucks.md +++ b/docs/docs/languages/nunjucks.md @@ -42,7 +42,7 @@ Example: In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the [result page](../features/result.md) runtime. -This can be achieved in JavaScript (or any [language](../languages/) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. +This can be achieved in JavaScript (or any [language](../languages/index.md) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. Please note that template rendering occurs on [page load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event), so the assignment must occur before that. diff --git a/docs/docs/languages/pug.md b/docs/docs/languages/pug.md index aa8ebde67..31a03e93f 100644 --- a/docs/docs/languages/pug.md +++ b/docs/docs/languages/pug.md @@ -42,7 +42,7 @@ Example: In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the [result page](../features/result.md) runtime. -This can be achieved in JavaScript (or any [language](../languages/) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. +This can be achieved in JavaScript (or any [language](../languages/index.md) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. Please note that template rendering occurs on [page load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event), so the assignment must occur before that. diff --git a/docs/docs/languages/twig.md b/docs/docs/languages/twig.md index 9ce48091b..9990fc50f 100644 --- a/docs/docs/languages/twig.md +++ b/docs/docs/languages/twig.md @@ -42,7 +42,7 @@ Example: In this mode, in addition to values supplied in custom settings (see above), expressions can have values that are evaluated during the [result page](../features/result.md) runtime. -This can be achieved in JavaScript (or any [language](../languages/) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. +This can be achieved in JavaScript (or any [language](../languages/index.md) that compiles to it) by assigning `window.livecodes.templateData` to an object with the data. Please note that template rendering occurs on [page load](https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event), so the assignment must occur before that. diff --git a/docs/docs/overview.md b/docs/docs/overview.md index c0ef6de99..3e06868e8 100644 --- a/docs/docs/overview.md +++ b/docs/docs/overview.md @@ -4,7 +4,7 @@ slug: /overview # Overview -[LiveCodes](https://livecodes.io) is an [open-source](./license.md) client-side code playground. It is [feature-rich](./features/) with support for [80+ languages/frameworks](./languages/). It can be used as a [standalone app](./getting-started.md#standalone-app) or [embedded](./features/embeds.md) in any web page. A powerful [SDK](./sdk/) is available to facilitate embedding and communication with embedded playgrounds. +[LiveCodes](https://livecodes.io) is an [open-source](./license.md) client-side code playground. It is [feature-rich](./features/index.md) with support for [80+ languages/frameworks](./languages/index.md). It can be used as a [standalone app](./getting-started.md#standalone-app) or [embedded](./features/embeds.md) in any web page. A powerful [SDK](./sdk/index.md) is available to facilitate embedding and communication with embedded playgrounds. The sections below include the documentation details: diff --git a/docs/docs/why.md b/docs/docs/why.md index d18f1598e..bff29c3fb 100644 --- a/docs/docs/why.md +++ b/docs/docs/why.md @@ -69,7 +69,7 @@ Please consider [sponsoring LiveCodes](./sponsor.md) if you find it useful, to s :::caution Under Development -LiveCodes is currently in **public beta**. It is in active development. However, please take the time to try it. Use [permanent URL](./features/permanent-url.md) and pinned [library version](./sdk/) to avoid breaking changes. Your feedback and contribution are highly appreciated. +LiveCodes is currently in **public beta**. It is in active development. However, please take the time to try it. Use [permanent URL](./features/permanent-url.md) and pinned [library version](./sdk/index.md) to avoid breaking changes. Your feedback and contribution are highly appreciated. ::: diff --git a/scripts/build.js b/scripts/build.js index 9b3c72109..27674dc7e 100644 --- a/scripts/build.js +++ b/scripts/build.js @@ -80,7 +80,7 @@ const prepareDir = async () => { ); await fs.promises.copyFile( path.resolve(__dirname + '/../src/livecodes/html/app-base.html'), - path.resolve(outDir + '/livecodes/app.html'), + path.resolve(outDir + '/app.html'), ); }; diff --git a/src/livecodes/main.ts b/src/livecodes/main.ts index c1a493ce1..6b7328306 100644 --- a/src/livecodes/main.ts +++ b/src/livecodes/main.ts @@ -69,7 +69,7 @@ export const livecodes = (container: string, config: Partial = {}): Prom const iframe = document.createElement('iframe'); iframe.name = 'app'; iframe.style.display = 'none'; - iframe.src = baseUrl + '{{hash:app.html}}'; + iframe.src = './app.html'; let contentLoaded = false; iframe.onload = () => { if (contentLoaded) return;