Make it more obvious how to add text

[elliot-100]

Is your feature request related to a problem? Please describe.

I've just started using Folium, and while it is very useful, I have been frustrated by the lack of documentation on how to add text elements - other than marker tooltips and popups, neither of which are initially visible to the user. As far as I can see there is nothing at all in the user guide or advanced guide.

A search for 'text' doesn't seem to point to anything relevant either, except PolyLineTextPath which is for a relatively specialist text case.

From StackOverflow etc. searches, the simplest solution for most cases seems to be to use a DivIcon for most cases. But that is very hidden in the documentation. I can see there are other methods via Leaflet or branca APIs.

Describe the solution you'd like

• Add a Text section to the user guide with recommended ways to add text elements.
• Add a bit of detail including the word 'text' to relevant API sections so they can be found more easily.

Describe alternatives you've considered
n/a

Additional context
n/a

Implementation
folium is maintained by volunteers. Can you help make a PR if we want to implement this feature?
Probably, depending on how complex it is to make docs changes.

[Conengmo]

That would be very welcome! Do you want to try adding this?

We don't have a separate entry for DivIcon in the user guide, that would be welcome. I suppose in user_guide/ui_elements/icons. Maybe that could contain an example to add text?

Alternatively, the advanced guide could have it's own page on adding text.

[elliot-100]

I've not actually used DivIconin my own projects yet; once I have I will try to add some guidance.

[mosessamofficial-sys]

Hi, I’d like to work on this issue. I can add documentation and examples using DivIcon for adding text elements.

[Balantah]

Hi! I'd like to work on this. I plan to add a section to the icons user guide showing how to use DivIcon to place visible text labels on a map, with a working code example. I have already set up the repo locally. Would that approach work?

[hansthen]

Sure. Any help would be greatly appreciated. It helps if you also read the contirbuting guide here https://github.com/python-visualization/folium/blob/main/.github/CONTRIBUTING.md. If you follow that, there some automated checks are installed in your repo that check the resulting documentation for errors.