Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rocker-org/website

A website for the Rocker Project
https://github.com/rocker-org/website

Last synced: about 2 months ago
JSON representation

A website for the Rocker Project

Awesome Lists containing this project

README

        

# [rocker-project.org](https://rocker-project.org)

A [website](https://rocker-project.org) for the Rocker Project.

## Contributing

Feedbacks & contributions are welcome!

If you find a documentation issue, please [open an issue this repository](https://github.com/rocker-org/website/issues/new)
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](https://quarto.org/docs/get-started/) and run the following command.

```sh
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](.github/workflows/main.yml).

### docker compose

You can use a Docker container instead of installing quarto cli locally
with following [docker compose](https://docs.docker.com/compose/) command.

```sh
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.

```sh
docker compose down --rmi all
```

### Dev Containers

You can quickly build a development environment for this repository
by building a [Dev Container](https://containers.dev/)
on [GitHub Codespaces](https://github.com/features/codespaces), etc.

## License

Content license: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).

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

- [quarto-ext/fontawesome](https://github.com/quarto-ext/fontawesome)