JuliaDocs/Documenter.jl

Location of JS/script assets in the HTML

Open

#1.433 aberto em 8 de out. de 2020

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Julia (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Métricas do repositório

Stars
 (910 stars)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (3 fundiu PRs em 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).

Guia do colaborador

Direção de pesquisa
Investigue o código de geração HTML no Documenter.jl, especificamente como os scripts são inseridos em relação ao RequireJS. Modifique a ordem de inserção para colocar os scripts fornecidos pelo usuário antes do RequireJS por padrão e adicione uma opção para personalizar a localização através da palavra chave asset().
Pilha de tecnologia
juliajavascript
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitJulia
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70