https://github.com/schochastics/quarto-nutshell

Include expandable explanations in quarto documents
https://github.com/schochastics/quarto-nutshell

quarto quarto-extension quarto-pub quartopub

Last synced: 3 months ago
JSON representation

Include expandable explanations in quarto documents

• Host: GitHub
• URL: https://github.com/schochastics/quarto-nutshell
• Owner: schochastics
• License: cc0-1.0
• Created: 2022-08-18T19:12:47.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-18T19:42:10.000Z (11 months ago)
• Last Synced: 2024-10-12T22:14:18.866Z (3 months ago)
• Topics: quarto, quarto-extension, quarto-pub, quartopub
• Language: JavaScript
• Homepage:
• Size: 786 KB
• Stars: 69
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Nutshell

![](nutshell.gif)

> Nutshell is a tool to make "expandable explanations" This lets your readers learn only the details they need, just-in-time, always-in-context.   

Unlike links, Nutshell lets you include only the snippet you need, not the whole page. Plus, instead of being lost in a jungle of new tabs, your reader stays on one page, keeping their flow of reading. Even if you interrupt a sentence, Nutshell recaps the sentence afterwards, so your reader never loses context.

You can find more information (and a demo) on the nutshell [webpage](https://ncase.me/nutshell/).

## Install

```sh

quarto install extension schochastics/quarto-nutshell

```

This will install the extension under the `_extensions` subdirectory. If you're using version control, you will want to check in this directory.

## Using

You can use the filter by adding

```

filters:

   - nutshell

```

to your yaml header.

To write a Nutshell snippet, just use headings & paragraphs. To embed a snippet,

just make a link, but with a :colon in the front:

```

[:link](https://en.wikipedia.org/wiki/Nutshell)

```

Note, however, the other webpage needs to also have Nutshell installed, or CORS enabled. If you own the other page, that's not a problem! But if not, you'll have to mirror/copy the other page.

Check out the [interactive demo](https://ncase.me/nutshell/try/) for more help

or head to the

[github repo](https://github.com/ncase/nutshell) to learn about the full

functionality of nutshell.

## Example

Here is the source code for a minimal example: [example.qmd](example.qmd)  

A rendered version can be found [here](https://schochastics.quarto.pub/nutshell-expandable-explanations/).