[mkdocs] some examples don't run in the docs
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- JavaScript
- Estrelas
- 18.3k
- Forks
- 2k
- Merge médio
- 2d 12h
- PRs com merge (30d)
- 28
Descrição
If you take an example like this from the current docs, it doesn't run in the mkdocs site
https://plotly.com/javascript/tile-map-layers/#openstreetmap-tiles
This example uses d3 but the mkdocs site isn't loading that.
We should:
- determine what other JS libraries are needed by the docs and ensure the are loaded
and/or - rewrite examples to make sure no additional JS libraries are needed
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece pelo exemplo de tiles do OpenStreetMap na documentação JavaScript vinculada e inspecione como o site MkDocs carrega seus scripts. Identifique os outros exemplos da documentação que dependem de bibliotecas JavaScript externas e, em seguida, garanta que essas bibliotecas sejam carregadas ou que os exemplos não precisem mais delas; o trabalho estará concluído quando os exemplos afetados forem executados no site MkDocs.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- d3, javascript
- Domínio
- documentation, web-dev
- Tipo de issue
- Bug
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100