Skip to content

Commit

Permalink
Merge branch 'main' into fil/save-search-query
Browse files Browse the repository at this point in the history
  • Loading branch information
Fil committed Aug 30, 2024
2 parents dc16d54 + bbea2c5 commit 2834b97
Show file tree
Hide file tree
Showing 221 changed files with 3,189 additions and 1,140 deletions.
10 changes: 3 additions & 7 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@ jobs:
key: data-${{ hashFiles('docs/data/*') }}-${{ steps.date.outputs.date }}
- run: yarn build
- run: yarn docs:build
- uses: cloudflare/pages-action@1
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
projectName: framework
directory: docs/.observablehq/dist
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
- run: yarn docs:deploy
env:
OBSERVABLE_TOKEN: ${{ secrets.OBSERVABLE_API_TOKEN }}
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
/coverage/
/dist/
/docs/.observablehq/dist/
/docs/theme/*.md
/docs/themes.md
/test/build/
/test/output/**/*-changed.*
/test/output/build/**/*-changed/
Expand Down
6 changes: 3 additions & 3 deletions docs/.observablehq/deploy.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"projectId": "497663d656fa5557",
"workspaceLogin": "observablehq",
"projectSlug": "cli"
"projectId": "b385d10b723e37b6",
"projectSlug": "framework",
"workspaceLogin": "observablehq"
}
12 changes: 10 additions & 2 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,10 @@ The pages list should _not_ include the home page (`/`) as this is automatically

Whether to show the previous & next links in the footer; defaults to true. The pages are linked in the same order as they appear in the sidebar.

## dynamicPaths <a href="https://github.com/observablehq/framework/pull/1523" class="observablehq-version-badge" data-version="prerelease" title="Added in #1523"></a>

The list of [parameterized pages](./params) and [dynamic pages](./page-loaders) to generate, either as a (synchronous) iterable of strings, or a function that returns an async iterable of strings if you wish to load the list of dynamic pages asynchronously.

## head

An HTML fragment to add to the head. Defaults to the empty string. If specified as a function, receives an object with the page’s `title`, (front-matter) `data`, and `path`, and must return a string.
Expand Down Expand Up @@ -224,7 +228,7 @@ These additional results may also point to external links if the **path** is spe
```js run=false
export default {
search: {
async* index() {
async *index() {
yield {
path: "https://example.com",
title: "Example",
Expand All @@ -237,7 +241,7 @@ export default {

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

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:
The **interpreters** option specifies additional interpreted languages for data loaders, indicating the file extension and associated interpreter. (See [loader routing](./data-loaders#routing) for more.) The default list of interpreters is:

```js run=false
{
Expand Down Expand Up @@ -300,3 +304,7 @@ The set of replacements for straight double and single quotes used when the [**t
## linkify <a href="https://github.com/observablehq/framework/releases/tag/v1.7.0" class="observablehq-version-badge" data-version="^1.7.0" title="Added in 1.7.0"></a>

If true (the default), automatically convert URL-like text to links in Markdown.

## globalStylesheets <a href="https://github.com/observablehq/framework/pull/1597" class="observablehq-version-badge" data-version="prerelease" title="Added in #1597"></a>

An array of links to global stylesheets to add to every page’s head, in addition to the [page stylesheet](#style). Defaults to loading [Source Serif 4](https://fonts.google.com/specimen/Source+Serif+4) from Google Fonts.
Loading

0 comments on commit 2834b97

Please sign in to comment.