quarto-dev / quarto-dev/quarto-cli

Quarto should output websites with "pretty" URLs

Open
#2,065 1 comment 15 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement websites
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

When using quarto to build websites, some static site generators, for instance mkdocs, create sites with "pretty" URLs by default. It would be great if Quarto also did this.

For instance, in a project containing the file science.md, quarto render will generate that as science.html, resulting in a URL like, https://example.com/science.html. In contrast, mkdocs build would generate it as science/index.html, meaning that, when published, it could be accessed at https://example.com/science/.

The current workaround would be to create the original file at science/index.md, in which case, both quarto and mkdocs would generate the same HTML in the same places.

This is important for sites that might be considering migrating to quarto that are not currently structured along the lines of the workaround.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the website rendering behavior exercised by quarto render and compare the science.md and science/index.md examples. Trace where output paths are chosen, then verify that science.md produces science/index.html and a published /science/ URL without breaking the existing workaround.

Written by the indexing model from the issue text.

Assessment

Domain
cli, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.