Skip to content

royfrancis/folium

Repository files navigation

folium

ci_badge linkcheck_badge

A quarto website template for project reports. For a single page template, see folium-webpage.

For a demo site, see here.

Usage

  • Required quarto 1.4.5 or higher

  • To download a starter template, run in the terminal

    ❗ Demo files are not downloaded

    quarto use template royfrancis/folium
    
  • Install required extensions

    quarto add quarto-ext/fontawesome
    
  • 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 <meta name="robots" content="noindex"> in head.

Acknowledgements


2026 • Roy Francis

About

A quarto website template for NBIS project reports

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors