Skip to content

Commit 4fd9c12

Browse files
committed
Merge branch 'fil/summary-table' of github.com:observablehq/framework into fil/summary-table
2 parents 89bcd4b + 45e81b5 commit 4fd9c12

File tree

93 files changed

+1094
-278
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+1094
-278
lines changed

.eslintrc.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"@typescript-eslint/no-explicit-any": 0,
2828
"@typescript-eslint/no-this-alias": 0,
2929
"@typescript-eslint/no-unused-vars": ["error", {"ignoreRestSiblings": true}],
30+
"import/consistent-type-specifier-style": "warn",
3031
"import/first": "warn",
3132
"import/newline-after-import": "warn",
3233
"import/no-duplicates": "off",

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
echo ::add-matcher::.github/eslint.json
2828
yarn run eslint src test --format=compact --max-warnings=0
2929
- run: yarn test:prettier
30-
- uses: actions/upload-artifact@v3
30+
- uses: actions/upload-artifact@v4
3131
if: failure()
3232
with:
3333
name: test-output-changes-${{ matrix.os }}-${{ matrix.version }}

docs/config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ export default {
174174

175175
The base path when serving the site. Currently this only affects the custom 404 page, if any.
176176

177-
## cleanUrls <a href="https://github.com/observablehq/framework/releases/tag/v1.3.0" target="_blank" class="observablehq-version-badge" data-version="^1.3.0" title="Added in 1.3.0"></a>
177+
## cleanUrls <a href="https://github.com/observablehq/framework/releases/tag/v1.3.0" class="observablehq-version-badge" data-version="^1.3.0" title="Added in 1.3.0"></a>
178178

179179
Whether page links should be “clean”, _i.e._, formatted without a `.html` extension. Defaults to true. If true, a link to `config.html` will be formatted as `config`. Regardless of this setting, a link to an index page will drop the implied `index.html`; for example `foo/index.html` will be formatted as `foo/`.
180180

@@ -207,7 +207,7 @@ toc: false
207207

208208
Whether to enable [search](./search) on the project; defaults to false.
209209

210-
## interpreters <a href="https://github.com/observablehq/framework/releases/tag/v1.3.0" target="_blank" class="observablehq-version-badge" data-version="^1.3.0" title="Added in 1.3.0"></a>
210+
## interpreters <a href="https://github.com/observablehq/framework/releases/tag/v1.3.0" class="observablehq-version-badge" data-version="^1.3.0" title="Added in 1.3.0"></a>
211211

212212
The **interpreters** option specifies additional interpreted languages for data loaders, indicating the file extension and associated interpreter. (See [loader routing](./loaders#routing) for more.) The default list of interpreters is:
213213

@@ -249,7 +249,7 @@ export default {
249249
};
250250
```
251251

252-
## markdownIt <a href="https://github.com/observablehq/framework/releases/tag/v1.1.0" target="_blank" class="observablehq-version-badge" data-version="^1.1.0" title="Added in v1.1.0"></a>
252+
## markdownIt <a href="https://github.com/observablehq/framework/releases/tag/v1.1.0" class="observablehq-version-badge" data-version="^1.1.0" title="Added in v1.1.0"></a>
253253

254254
A hook for registering additional [markdown-it](https://github.com/markdown-it/markdown-it) plugins. For example, to use [markdown-it-footnote](https://github.com/markdown-it/markdown-it-footnote):
255255

docs/data/forecast.json

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

docs/deploying.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ npm run deploy
2424

2525
The first time you deploy a project, you will be prompted to configure the project’s _slug_ (which determines its URL), access level, and other details. If you don’t yet have an Observable account or aren’t signed-in, you will also be prompted to sign-up or sign-in.
2626

27-
When the deploy command finishes, it prints a link to observablehq.cloud where you can view your deployed project. If you choose *private* as the access level, that link will only be accessible to members of your Observable workspace. (You can invite people to your workspace by going to observablehq.com.) If you chose *public*, you can share your project link with anyone.
27+
When the deploy command finishes, it prints a link to observablehq.cloud where you can view your deployed project. If you choose *private* as the access level, that link will only be accessible to members of your Observable workspace. (You can invite people to your workspace by going to observablehq.com.) If you chose *public*, you can share your project link with anyone. You can change the access level of a project later [from your workspace projects page](https://observablehq.com/select-workspace?next=projects).
2828

2929
<div class="note">The deploy command creates a file at <code>docs/.observablehq/deploy.json</code> with information on where to deploy the project. This file is required for automated deploys. You will need to commit this file to git to deploy via GitHub Actions. (If you have configured a source root besides <code>docs</code>, the file will be placed there instead.)</div>
3030

@@ -68,13 +68,11 @@ When deploying automatically, you can’t sign-in in your browser the way you di
6868

6969
To create an API key:
7070

71-
1. Go to [observablehq.com](https://observablehq.com).
72-
2. In the left sidebar, click **Settings**.
73-
3. In the right sidebar, click **API / Notebook Keys**.
74-
4. Click **New API Key**.
75-
5. Check the **Deploy new versions of projects** checkbox.
76-
6. Give your key a description, such as “Deploy via GitHub Actions”.
77-
7. Click **Create API Key**.
71+
1. Open the [API Key settings](https://observablehq.com/select-workspace?next=api-keys-settings) for your Observable workspace.
72+
2. Click **New API Key**.
73+
3. Check the **Deploy new versions of projects** checkbox.
74+
4. Give your key a description, such as “Deploy via GitHub Actions”.
75+
5. Click **Create API Key**.
7876

7977
<div class="caution">
8078

docs/getting-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ Next, decide whether you want sample files in your new project. These files demo
122122
<pre data-copy="none"><span class="muted">┌</span> <span class="invert"> observable create </span>
123123
<span class="muted">│</span>
124124
<span class="green">◇</span> Where to create your project?
125-
<span class="muted">│</span> <span class="muted">./hello-framework</span>
125+
<span class="muted">│</span> <span class="muted">hello-framework</span>
126126
<span class="muted">│</span>
127127
<span class="green">◇</span> What to title your project?
128128
<span class="muted">│</span> <span class="muted">Hello Framework</span>
@@ -194,7 +194,7 @@ And that’s it! After some downloading, copying, and installing, your new proje
194194
<span class="muted">│</span>
195195
<span class="green">◇</span> Next steps… <span class="muted">──────────╮</span>
196196
<span class="muted">│</span> <span class="muted">│</span>
197-
<span class="muted">│</span> <span class="focus">cd hello-framework</span> <span class="muted">│</span>
197+
<span class="muted">│</span> <span class="focus">cd hello-framework</span> <span class="muted">│</span>
198198
<span class="muted">│</span> <span class="focus">yarn dev</span> <span class="muted">│</span>
199199
<span class="muted">│</span> <span class="muted">│</span>
200200
<span class="muted">├────────────────────────╯</span>
@@ -221,7 +221,7 @@ Or with Yarn:
221221

222222
You should see something like this:
223223

224-
<pre data-copy="none"><b class="green">Observable Framework</b> v1.3.0
224+
<pre data-copy="none"><b class="green">Observable Framework</b> v1.5.1
225225
↳ <u><a href="http://127.0.0.1:3000/" style="color: inherit;">http://127.0.0.1:3000/</a></u></pre>
226226

227227
<div class="tip">

docs/inputs/button.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Button input
22

3-
<a href="https://github.com/observablehq/inputs/blob/main/README.md#button" target="_blank">API</a> · <a href="https://github.com/observablehq/inputs/blob/main/src/button.js" target="_blank">Source</a> · The button input emits an *input* event when you click it. Buttons may be used to trigger the evaluation of cells, say to restart an animation. For example, below is an animation that progressively hides a bar. Clicking the button will restart the animation.
3+
<a href="https://github.com/observablehq/inputs/blob/main/README.md#button">API</a> · <a href="https://github.com/observablehq/inputs/blob/main/src/button.js">Source</a> · The button input emits an *input* event when you click it. Buttons may be used to trigger the evaluation of cells, say to restart an animation. For example, below is an animation that progressively hides a bar. Clicking the button will restart the animation.
44

55
<canvas id="canvas" width="360" height="20" style="max-width: 100%; color: var(--theme-foreground-focus); border: solid 1px var(--theme-foreground);"></canvas>
66

docs/inputs/checkbox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Checkbox input
22

3-
<a href="https://github.com/observablehq/inputs/blob/main/README.md#checkbox" target="_blank">API</a> · <a href="https://github.com/observablehq/inputs/blob/main/src/checkbox.js" target="_blank">Source</a> · The checkbox input allows the user to choose any of a given set of values. (See the [radio](./radio) input for single-choice.) A checkbox is recommended over a [select](./select) input when the number of values to choose from is small — say, seven or fewer — because all choices will be visible up-front, improving usability. For zero or one choice, see the [toggle](./toggle) input.
3+
<a href="https://github.com/observablehq/inputs/blob/main/README.md#checkbox">API</a> · <a href="https://github.com/observablehq/inputs/blob/main/src/checkbox.js">Source</a> · The checkbox input allows the user to choose any of a given set of values. (See the [radio](./radio) input for single-choice.) A checkbox is recommended over a [select](./select) input when the number of values to choose from is small — say, seven or fewer — because all choices will be visible up-front, improving usability. For zero or one choice, see the [toggle](./toggle) input.
44

55
The initial value of a checkbox defaults to an empty array. You can override this by specifying the *value* option, which should also be an array (or iterable).
66

docs/inputs/color.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Color input
22

3-
<a href="https://github.com/observablehq/inputs/blob/main/README.md#inputscoloroptions" target="_blank">API</a> · <a href="https://github.com/observablehq/inputs/blob/main/src/color.js" target="_blank">Source</a> · The color input specifies an RGB color as a hexadecimal string `#rrggbb`. The initial value defaults to black (`#000000`) and can be specified with the *value* option.
3+
<a href="https://github.com/observablehq/inputs/blob/main/README.md#inputscoloroptions">API</a> · <a href="https://github.com/observablehq/inputs/blob/main/src/color.js">Source</a> · The color input specifies an RGB color as a hexadecimal string `#rrggbb`. The initial value defaults to black (`#000000`) and can be specified with the *value* option.
44

55
```js echo
66
const color = view(Inputs.color({label: "Favorite color", value: "#4682b4"}));

docs/inputs/date.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Date input
22

3-
<a href="https://github.com/observablehq/inputs/blob/main/README.md#date" target="_blank">API</a> · <a href="https://github.com/observablehq/inputs/blob/main/src/date.js" target="_blank">Source</a> · The date input specifies a date.
3+
<a href="https://github.com/observablehq/inputs/blob/main/README.md#date">API</a> · <a href="https://github.com/observablehq/inputs/blob/main/src/date.js">Source</a> · The date input specifies a date.
44

55
```js echo
66
const date = view(Inputs.date());

0 commit comments

Comments
 (0)