JuliaDocs/Documenter.jl

Location of JS/script assets in the HTML

Open

#1.433 geöffnet am 8. Okt. 2020

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (513 Forks)batch import
Format: HTMLType: Enhancementhelp wanted

Repository-Metriken

Stars
 (910 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuchen Sie den HTML Generierungscode in Documenter.jl, insbesondere wie Skript Assets relativ zu RequireJS eingefügt werden. Ändern Sie die Einfügungsreihenfolge, um benutzerdefinierte Skripte standardmäßig vor RequireJS zu platzieren, und fügen Sie eine Option hinzu, um die Position über das asset() Schlüsselwort anzupassen.
Tech Stack
juliajavascript
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJulia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70