Skip to content

Commit

Permalink
Merge pull request #419 from live-codes/fix-urls
Browse files Browse the repository at this point in the history
Fix URLs
  • Loading branch information
hatemhosny authored Aug 20, 2023
2 parents f2d6ff2 + 2114e1b commit 32efcc5
Show file tree
Hide file tree
Showing 28 changed files with 81 additions and 81 deletions.
82 changes: 41 additions & 41 deletions docs/docs/configuration/configuration-object.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,39 +55,39 @@ 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"`

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: `""`

Project description. Used in [project](../features/projects.md) search. This can be set in the UI from app menu → Project Info.

### `tags`

Type: [`string[]`](../api/interfaces/Config#tags)
Type: [`string[]`](../api/interfaces/Config.md#tags)

Default: `[]`

Project tags. Used in [project](../features/projects.md) filter and search. This can be set in the UI from app menu → Project Info.

### `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"

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).

Expand All @@ -97,39 +97,39 @@ 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: `[]`

List of URLs for [external stylesheets](../features/external-resources.md) to add to the [result page](../features/result.md).

### `scripts`

Type: [`string[]`](../api/interfaces/Config#scripts)
Type: [`string[]`](../api/interfaces/Config.md#scripts)

Default: `[]`

Expand Down Expand Up @@ -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: `{}`

Expand Down Expand Up @@ -270,15 +270,15 @@ Example:

### `tests`

Type: `undefined` | `Partial`<[`Editor`](../api/interfaces/internal.Editor)>
Type: `undefined` | `Partial`<[`Editor`](../api/interfaces/internal.Editor.md)>

Default: `{ language: 'typescript', content: '' }`

Configures the [language](../features/tests.md#supported-languages) and content of [tests](../features/tests.md).

### `version`

Type: `Readonly` [`string`](../api/interfaces/Config#description)
Type: `Readonly` [`string`](../api/interfaces/Config.md#description)

Default: Current LiveCodes Version.

Expand All @@ -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`

Expand All @@ -307,23 +307,23 @@ 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`

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"`

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: '' }`

Expand All @@ -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`

Expand All @@ -357,63 +357,63 @@ 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`

If `true`, the result page is automatically updated on code change, after time [delay](#delay).

### `autosave`

Type: [`boolean`](../api/interfaces/Config#autosave)
Type: [`boolean`](../api/interfaces/Config.md#autosave)

Default: `false`

If `true`, the project is automatically saved on code change, after time [delay](#delay).

### `delay`

Type: [`number`](../api/interfaces/Config#delay)
Type: [`number`](../api/interfaces/Config.md#delay)

Default: `1500`

Time delay (in milliseconds) follwing code change, after which the result page is updated (if [`autoupdate`](#autoupdate) is `true`) and/or the project is saved (if [`autosave`](#autosave) is `true`).

### `formatOnsave`

Type: [`boolean`](../api/interfaces/Config#formatonsave)
Type: [`boolean`](../api/interfaces/Config.md#formatonsave)

Default: `false`

If `true`, the code is automatically [formatted](../features/code-format.md) on saving the project.

### `theme`

Type: [`"light" | "dark"`](../api/interfaces/Config#theme)
Type: [`"light" | "dark"`](../api/interfaces/Config.md#theme)

Default: `"dark"`

Sets the app [theme](../features/themes.md).

### `recoverUnsaved`

Type: [`boolean`](../api/interfaces/Config#recoverunsaved)
Type: [`boolean`](../api/interfaces/Config.md#recoverunsaved)

Default: `true`

Enables [recovering last unsaved project](../features/recover.md) when the app is reopened.

### `showSpacing`

Type: [`boolean`](../api/interfaces/Config#showspacing)
Type: [`boolean`](../api/interfaces/Config.md#showspacing)

Default: `false`

Enables [showing element spacing](../features/result.md#show-spacings) in the result page.

### `editor`

Type: [`"monaco" | "codemirror" | "codejar" | undefined`](../api/interfaces/Config#editor)
Type: [`"monaco" | "codemirror" | "codejar" | undefined`](../api/interfaces/Config.md#editor)

Default: `undefined`

Expand All @@ -423,15 +423,15 @@ 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`

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`

Expand All @@ -441,79 +441,79 @@ 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`

If `true`, lines are indented with tabs instead of spaces. Also used in [code formatting](../features/code-format.md).

### `tabSize`

Type: [`number`](../api/interfaces/Config#tabsize)
Type: [`number`](../api/interfaces/Config.md#tabsize)

Default: `2`

The number of spaces per indentation-level. Also used in [code formatting](../features/code-format.md).

### `lineNumbers`

Type: [`boolean`](../api/interfaces/Config#linenumbers)
Type: [`boolean`](../api/interfaces/Config.md#linenumbers)

Default: `true`

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`

Enables word-wrap for long lines.

### `closeBrackets`

Type: [`boolean`](../api/interfaces/Config#closebrackets)
Type: [`boolean`](../api/interfaces/Config.md#closebrackets)

Default: `true`

Use auto-complete to close brackets and quotes.

### `emmet`

Type: [`boolean`](../api/interfaces/Config#emmet)
Type: [`boolean`](../api/interfaces/Config.md#emmet)

Default: `true`

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`

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`

Configures Prettier [code formatter](../features/code-format.md) to use [semi-colons](https://prettier.io/docs/en/options.html#semicolons).

### `singleQuote`

Type: [`boolean`](../api/interfaces/Config#singlequote)
Type: [`boolean`](../api/interfaces/Config.md#singlequote)

Default: `false`

Configures Prettier [code formatter](../features/code-format.md) to use [single quotes instead of double quotes](https://prettier.io/docs/en/options.html#quotes).

### `trailingComma`

Type: [`boolean`](../api/interfaces/Config#trailingcomma)
Type: [`boolean`](../api/interfaces/Config.md#trailingcomma)

Default: `true`

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/configuration/query-params.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/features/ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Loading

0 comments on commit 32efcc5

Please sign in to comment.