JuliaDocs/Documenter.jl

Location of JS/script assets in the HTML

Open

#1433 aperta il 8 ott 2020

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Julia (513 fork)batch import
Format: HTMLType: Enhancementhelp wanted

Metriche repository

Star
 (910 star)
Metriche merge PR
 (Merge medio 16g 9h) (3 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Indagare il codice di generazione HTML in Documenter.jl, in particolare come vengono inseriti gli script rispetto a RequireJS. Modificare l'ordine di inserimento per posizionare gli script forniti dall'utente prima di RequireJS per impostazione predefinita e aggiungere un'opzione per personalizzare la posizione tramite la parola chiave asset().
Tech stack
juliajavascript
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitJulia
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70