JuliaDocs/Documenter.jl

Location of JS/script assets in the HTML

Open

#1 433 ouverte le 8 oct. 2020

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Julia (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Métriques du dépôt

Stars
 (910 stars)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

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).

Guide contributeur

Direction de recherche
Examinez le code de génération HTML dans Documenter.jl, en particulier la manière dont les scripts sont insérés par rapport à RequireJS. Modifiez l'ordre d'insertion pour placer les scripts fournis par l'utilisateur avant RequireJS par défaut et ajoutez une option pour personnaliser l'emplacement via le mot clé asset().
Stack technique
juliajavascript
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitJulia
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70