Skip to content

Seance of Communication Channels
Compare
Choose a tag to compare
@coatless coatless released this 17 Sep 10:36
· 133 commits to main since this release
0.3.5
046554d

Features

  • New documentation website is available at: https://quarto-webr.thecoatlessprofessor.com
  • Document option channel-type sets the communication channel webR uses.
    • channel-type: automatic (default): Communicates using either shared-array-buffer or service-worker.
    • channel-type: shared-buffer-array: Fastest communication option, but requires setting up HTTP headers.
    • channel-type: service-worker: Slower communication option and requires worker scripts to be next to the rendered document.
    • channel-type: post-message: Easiest setup option at the expense of being unable to interrupt the R process or accept user-input.
  • Code cell option context controls whether the code and output are shown or suppressed.
    • context: interactive(default) shows both code and output.
    • context: setup suppresses both code and output.
    • context: output suppresses code but shows its output.
    • To use the new hidden code cell feature, the code cell needs #| context: <value> like so:
```{webr-r}
#| context: setup

my_hidden_variable = 11
```

Bugfixes

  • Fixed webR status indicator appearing outside of the header. (#33)
  • Fixed button styling difference between standalone documents and website-based documents.

Documentation

  • Created the docs folder inside the repository to host the documentation website.
  • Moved documentation from the README.md file onto separate web pages.
    • Acknowledgements now has a dedicated page thanking contributors and collaborators.
    • Developer resources expands on the reference resources.
    • Using R packages describes the best practices for using R's ecosystem of extensions
    • Customization Options describes the document level options available to be set in document's YAML field.
  • Added new documentation entries for hidden code cell evaluation and communication channels.
  • Added a rendered version of the README example to the website.
  • Incorporated additional examples into the "Exploring Interactive Code Cells" demo document.

Deployment

  • Added a Quarto action to render and publish the documentation website.
  • Added issue templates for feature requests and bug fixes.
  • Symlink the _extension directory into docs to avoid needing to add the extension on each render.
Assets 2
Loading