plotly / plotly/plotly.js

[mkdocs] some examples don't run in the docs

Offen
#7,640 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug
Vorherrschende Sprache
JavaScript
Sterne
18.3k
Forks
2k
Ø Merge
2 T. 12 Std.
Gemergte PRs (30 T.)
28

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit dem OpenStreetMap-Kachelbeispiel in der verlinkten JavaScript-Dokumentation und untersuchen Sie, wie die MkDocs-Website ihre Skripte lädt. Identifizieren Sie die anderen Dokumentationsbeispiele, die von externen JavaScript-Bibliotheken abhängen, und stellen Sie dann sicher, dass diese Bibliotheken geladen werden oder die Beispiele sie nicht mehr benötigen; abgeschlossen ist die Aufgabe, wenn die betroffenen Beispiele auf der MkDocs-Website ausgeführt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
d3, javascript
Bereich
documentation, web-dev
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.