/website

A website for the Rocker Project

Primary LanguageLuaCreative Commons Attribution 4.0 InternationalCC-BY-4.0

A website for the Rocker Project.

Contributing

Feedbacks & contributions are welcome!

If you find a documentation issue, please open an issue this repository or edit the Markdown file included in this repository and open a Pull Request.

When the PullRequest is merged, the website is updated by GitHub Actions.

Local build

quarto cli

Install Quarto CLI and run the following command.

quarto preview

Then, the website is displayed on the local web server, and the generated website is located in the docs directory.

Note that, the Quarto CLI version which build the deployed website may be specified in the GitHub Actions workflow definition file.

docker compose

You can use a Docker container instead of installing quarto cli locally with following docker compose command.

docker compose up

Then, open localhost:8000 to preview the website.

Once you have finished checking, you can delete the images and the container with the following command.

docker compose down --rmi all

Dev Containers

You can quickly build a development environment for this repository by building a Dev Container on GitHub Codespaces, etc.

License

Content license: CC BY 4.0.

The _extensions directory contains the source code of quarto extensions installed from external repositories. Please refer to these repositories for information on these licenses.