https://github.com/royfrancis/folium
A quarto website template for NBIS project reports
https://github.com/royfrancis/folium
quarto quarto-project quarto-template quarto-theme quarto-website
Last synced: 3 months ago
JSON representation
A quarto website template for NBIS project reports
- Host: GitHub
- URL: https://github.com/royfrancis/folium
- Owner: royfrancis
- License: other
- Created: 2023-03-12T12:57:54.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-16T17:02:26.000Z (4 months ago)
- Last Synced: 2026-02-17T00:27:01.712Z (4 months ago)
- Topics: quarto, quarto-project, quarto-template, quarto-theme, quarto-website
- Language: SCSS
- Homepage: https://royfrancis.github.io/folium
- Size: 3.95 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# folium 
[](https://github.com/royfrancis/folium/actions?workflow=deploy) [](https://github.com/royfrancis/folium/actions?workflow=linkcheck)
A quarto website template for project reports. For a single page template, see [folium-webpage](https://github.com/royfrancis/folium-webpage).
For a demo site, see [here](https://royfrancis.github.io/folium).
## Usage
- Required quarto 1.4.549 or higher
- To download a starter template, run in the terminal
:exclamation: Demo files are not downloaded
```
quarto use template royfrancis/folium
```
- Launch preview in the browser
```
quarto preview
```
Note that preview will attempt to build all documents.
- Render all html files into `docs` directory
```
quarto render
```
## Tips
- Template directory structure
```
.
├── assets
├── completion.qmd
├── _extensions
├── index.qmd
├── _quarto.yml
└── reports
└── report.qmd
```
- Update `nbis` variables in **_quarto.yml**
- Add/modify reports in the `reports` directory as needed
- To selectively preview/render files:
```
quarto preview reports/report.qmd
quarto render reports/report.qmd
```
- To remove automatic list of files from the sidebar, remove `sidebar` from **_quarto.yml**.
- You can optionally manually link reports in `index.qmd` like this:
```
[Report](reports/report.qmd)
```
- If project is incomplete, set `completion.qmd` to not be rendered in **_quarto.yml**.
```
render:
- "*.qmd"
- "!completion.qmd"
```
- Use `##` as the highest level heading. Do not use `#`.
- The site won't be indexed by search engines (probably) due to `` in head.
## Acknowledgements
- Built using [Quarto](https://quarto.org/)
---
2025 • Roy Francis