Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open
  • Is something wrong?
#7,640 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
d3, javascript
Domain
documentation, web-dev

Research direction

Start with the OpenStreetMap tiles example in the linked JavaScript documentation and inspect how the MkDocs site loads its scripts. Identify the other documentation examples that depend on external JavaScript libraries, then ensure those libraries are loaded or the examples no longer require them; done means the affected examples run on the MkDocs site.

Written by the indexing model from the issue text.

Description

bug

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
Dominant language
JavaScript
Stars
18.3k
Forks
2k
Avg merge
1d 19h
Merged PRs (30d)
21

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from plotly/plotly.js

All issues in plotly/plotly.js

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.