https://github.com/voila-dashboards/voici-gallery

A gallery of Voici examples
https://github.com/voila-dashboards/voici-gallery

dashboards gallery jupyter notebook voici

Last synced: 4 months ago
JSON representation

A gallery of Voici examples

• Host: GitHub
• URL: https://github.com/voila-dashboards/voici-gallery
• Owner: voila-dashboards
• Created: 2023-04-17T21:23:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-11T18:14:57.000Z (11 months ago)
• Last Synced: 2025-06-19T14:11:30.936Z (5 months ago)
• Topics: dashboards, gallery, jupyter, notebook, voici
• Language: TypeScript
• Homepage: https://voila-dashboards.github.io/voici-gallery
• Size: 35.5 MB
• Stars: 7
• Watchers: 5
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

          
# Voici Gallery

![Github Actions Status](https://github.com/voila-dashboards/voici-gallery/actions/workflows/deploy.yml/badge.svg)

This is a gallery of [Voici](https://github.com/voila-dashboards/voici) examples. View the gallery at https://voila-dashboards.github.io/voici-gallery/

## Contributing new examples

1. Create a repository with your notebook. You can start from the [voici-demo](https://github.com/voila-dashboards/voici-demo) example.

2. Create a PR to [Voici gallery](https://github.com/voila-dashboards/voici-gallery) that

   modifies `script/gallery.yaml` file.

   You will need to fill in the following fields:

   - `title`: the title used in the page thumbnail.

   - `description`: the description used in the page thumbnail.

   - `repo_url`: the URL of the repository containing the notebooks and resources used to build the Voici dashboard.

   - `content_path`: the local path to the notebooks, this path will be passed to the `--contents` parameter of `Voici` command, default to `.`

   - `branch`: the branch to be checked out from `repo_url` repository, default to `main`.

   - `dashboard_url`: the URL of the deployed voici dashboard. If the voici dashboard is already deployed elsewhere you can use this field to bypass the build step. If you use this option, you do not need to provide the `repo_url`, `content_path` and the `branch` field.

   - `image_url`: the URL of the picture to use as thumbnail.

   - `image_path`: alternate way to provide your thumbnail image, by adding it to the `public/images` directory on this repository and providing the path in this parameter.

3. Once the PR is merged into `main`, the gallery is automatically redeployed and the new example will be visible shortly after.

## Development

See [CONTRIBUTING.md](./CONTRIBUTING.md) for more detail on developing the gallery.

## Related projects

- [Voici](https://github.com/voila-dashboards/voici): Voici turns any Jupyter Notebook into a static web application