JuliaDocs/Documenter.jl

Per-`Page` override of page title

Open

#1,898 opened on Aug 5, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Julia (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

Description

Currently, if you go to the documentation of a Julia package e.g. https://juliadocs.github.io/Documenter.jl/ the <title> element of the page is <title>Home · Documenter.jl</title>, where the "Home" comes from the first item on the dropdown menu. Is there a way to separate those two? The element seems to be important for google search results, thus it would be nice to have finer control over it.

Contributor guide

Research direction
Explore the Documenter.jl source code for how the page title is currently generated from the navigation. Look for the relevant HTML template or Julia function that sets the <title> tag. Propose a configuration option to override the title per page, perhaps in the @pages section or via a custom metadata field.
Tech stack
julia
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JuliaDocumenter.jl
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65