Skip to content

Commit

Permalink
Add README content
Browse files Browse the repository at this point in the history
  • Loading branch information
coatless committed May 1, 2024
1 parent 1a295f8 commit 3b450b0
Showing 1 changed file with 4 additions and 19 deletions.
23 changes: 4 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,10 @@
# Quarto Extension Development with Lua in a Devcontainer
# Demo CD Workflow

This repository houses a devcontainer that setups a [Quarto extension development environment](https://quarto.org/docs/extensions/lua.html). The container is setup to work with [GitHub Codespaces](https://github.com/features/codespaces) to instantly have a cloud-based developer workflow.
This repository houses an example workflow that allows for continuous deployment of Quarto documents that have been augmented by Quarto Extensions like [`{quarto-webr}`](https://github.com/coatless/quarto-webr) and [`{quarto-pyodide}`](https://github.com/coatless-quarto/pyodide). Feel free to clone or fork the repository!

You can try out the Codespace by clicking on the following button:
Alternatively, if you are comfortable with VS Code, you can try out the Codespace by clicking on the following button:

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/coatless-devcontainer/quarto-extension-dev?quickstart=1)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/coatless-quarto/quarto-webr-pyodide-demo?quickstart=1)

**Note:** Codespaces are available to Students and Teachers for free [up to 180 core hours per month](https://docs.github.com/en/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom#about-github-codespaces) through [GitHub Education](https://education.github.com/). Otherwise, you will have [up to 60 core hours and 15 GB free per month](https://github.com/features/codespaces#pricing).

The devcontainer contains:

- The latest [pre-release](https://quarto.org/docs/download/prerelease) version of Quarto.
- [Quarto VS Code Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto).
- [Lua LSP VS Code Extension](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) for Lua code intelligence.
- [GitHub copilot VS Code Extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot).
- `R` and `Python`
- `knitr` and `jupyter`

## References

- [Quarto: Lua API Reference](https://quarto.org/docs/extensions/lua-api.html)
- [Quarto: Lua Development](https://quarto.org/docs/extensions/lua.html)
- [Pandoc: Lua Filters](https://pandoc.org/lua-filters.html)
- [Lua: Manual](https://www.lua.org/manual/5.4/)

0 comments on commit 3b450b0

Please sign in to comment.