Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom template documentation outdated #1439

Open
Paul-Aime opened this issue Jan 21, 2024 · 0 comments
Open

Custom template documentation outdated #1439

Paul-Aime opened this issue Jan 21, 2024 · 0 comments

Comments

@Paul-Aime
Copy link

The documentation on "Creating your own template" seems outdated.

The documentation talks about base.tpl and voila.tpl files and default folder, nowhere to be found in the installated files, except in the 5 years old voila-template-cookiecutter.

After installing voila-0.5.5, this is the files structure I got:

$ tree -L 2 ~/miniconda3/envs/voila/share/jupyter/voila/templates/
/home/paul/miniconda3/envs/voila/share/jupyter/voila/templates/
├── base/
│  ├── static/
│  ├── 404.html
│  ├── browser-open.html
│  ├── error.html
│  ├── jupyter_widgets.html.j2
│  ├── log.macro.html.j2
│  ├── page.html
│  ├── spinner.macro.html.j2
│  ├── tree.html
│  └── voila_setup.macro.html.j2
├── classic/
│  └── index.html.j2
├── lab/
│  ├── browser-open.html
│  ├── error.html
│  ├── index.html.j2
│  ├── page.html
│  ├── tree-lab.html
│  └── tree.html
└── reveal/
   └── index.html.j2

Whereas "The Voilà template structure" documentation says:

$ tree path/to/env/share/jupyter/voila/templates/default/
├── nbconvert_templates
│   ├── base.tpl
│   └── voila.tpl
└── templates
    ├── 404.html
    ├── error.html
    ├── page.html
    └── tree.html

Also, I can't make any of the linked example template projects work (voila-dashboards/voila-gridstack, voila-dashboards/voila-material, voila-dashboards/voila-vuetify)

How should I go learning about making my own template?

Actually, I mainly wants to make the voila-vuetify template work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant