Skip to content

Commit

Permalink
1.1.0 (#975)
Browse files Browse the repository at this point in the history
* 1.1.0

* remove cautionary note about windows (#959)

* document keywords, again

* don’t run footnote example

---------

Co-authored-by: Philippe Rivière <[email protected]>
  • Loading branch information
mbostock and Fil authored Mar 4, 2024
1 parent 27c5d2a commit 2a17313
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ Whether to enable [search](./search) on the project; defaults to false.

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

```js
```js run=false
import type MarkdownIt from "markdown-it";
import MarkdownItFootnote from "markdown-it-footnote";

Expand Down
2 changes: 0 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,6 @@ Framework includes a helper script (`observable create`) for creating new projec
<p>If you run into difficulty following this tutorial, we’re happy to help! Please visit the <a href="https://talk.observablehq.com">Observable forum</a> or our <a href="https://github.com/observablehq/framework/discussions">GitHub discussions</a>.</p>
</div>

<div class="caution">Framework does not currently support Windows, though some users have had success with the <a href="https://learn.microsoft.com/en-us/windows/wsl/install">Windows Subsystem for Linux (WSL)</a>. It you are interested in Windows support, please upvote <a href="https://github.com/observablehq/framework/issues/90">#90</a>.</div>

To create a new project with npm, run:

<pre data-copy>npm init @observablehq</pre>
Expand Down
10 changes: 10 additions & 0 deletions docs/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,13 @@ index: true
```

Search is case-insensitive. The indexing script tries to avoid common pitfalls by ignoring HTML tags and non-word characters such as punctuation. It also ignores long words, as well as sequences that contain more than 6 digits (such as API keys, for example).

You can specify additional comma-separated words to index using the **keywords** option in [Markdown front matter](./markdown). For example:

```yaml
---
keywords: file, fileattachment
---
```

These keywords are boosted at the same weight as the page title.
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
{
"name": "@observablehq/framework",
"license": "ISC",
"version": "1.1.0-rc.1",
"version": "1.1.0",
"type": "module",
"publishConfig": {
"access": "public",
"tag": "next"
"access": "public"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit 2a17313

Please sign in to comment.