JuliaDocs/Documenter.jl

Location of JS/script assets in the HTML

Open

#1,433 opened on Oct 8, 2020

View on GitHub
 (2 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

The user can include additional JS scripts in the HTML page by passing the URLs via the assets keyword to HTML. Currently, the generated <script> tags get placed after the built-in dependencies (including RequireJS, which can cause issues). Based on that discussion, it looks like we could handle it better:

  • By default, place the user-provided <script> tags before the RequireJS loading (works around the issues with libraries that do not play well with RequireJS if they are loaded separately: https://github.com/requirejs/requirejs/issues/947#issuecomment-28677913).
  • Allow the user to customize the location with a keyword to asset() (e.g. before, after RequireJS, at the end of the HTML file).

Contributor guide

Research direction
Investigate the HTML generation code in Documenter.jl, specifically how script assets are inserted relative to RequireJS. Modify the insertion order to place user provided scripts before RequireJS by default and add an option to customize the location via the asset() keyword.
Tech stack
juliajavascript
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.
Half day
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
GitJulia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70