From 3f2d5020399b633b0e24baa2b24504bad2a4b842 Mon Sep 17 00:00:00 2001 From: James Foster Date: Sat, 23 Aug 2025 00:23:00 +1000 Subject: [PATCH] [docs] Update wording in Home. --- docs/src/index.md | 50 +++++++++++++++++++++++++++-------------------- 1 file changed, 29 insertions(+), 21 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index c11eeaf7..20439685 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,52 +1,60 @@ # PlotlyJS -Welcome to the documentation for `PlotlyJS.jl`, a Julia interface to the +Welcome to the documentation for PlotlyJS.jl, a Julia interface to the [plotly.js](https://plotly.com/javascript) visualization library. -This package does not interact with the [Plotly web -API](https://api.plot.ly/v2/), but rather leverages the underlying javascript -library to construct plotly graphics using all local resources. This means you -do not need a Plotly account or an internet connection to use this package. +The goals of PlotlyJS.jl are to: -The goals of `PlotlyJS.jl` are: - -1. Make it convenient to construct and manipulate plotly visualizations -2. Provide infrastructure for viewing plots on multiple frontends and saving -plotly graphics to files +1. make it convenient to construct and manipulate plotly visualizations; +2. provide the infrastructure for viewing and interacting with plots from + different front-ends such as the Julia REPL, web browsers and IDEs; +3. save plotly graphics to files in different formats. ## Getting Help There are three primary resources for getting help with using this library: -1. The [Julia discourse page](https://discourse.julialang.org/). This is your best option if the question you have is specific to Julia. Appropriate topics include how to integrate with other Julia packages or how to use plotly features unique to `PlotlyJS.jl` -2. The [julia channel](https://community.plotly.com/c/plotly-r-matlab-julia-net/julia/23) on the plotly discussion page. This is your best option if you want visibility from other parts of the plotly community including python and R users. -3. [GitHub Issues](https://github.com/JuliaPlots/PlotlyJS.jl/issues). This is appropriate only for bug reports or feature requests. General usage questions should not be posted to GitHub, but rather should utilize one of the discussion forums above +1. The [Julia Discourse page](https://discourse.julialang.org/). + This is your best option if the question you have is specific to Julia. + Appropriate topics include how to integrate with other Julia packages + or how to use plotly features unique to PlotlyJS.jl. +2. The [julia channel](https://community.plotly.com/c/plotly-r-matlab-julia-net/julia/23) + on the plotly discussion page. This is your best option if you want visibility from other parts of the plotly community including python and R users. +3. [GitHub Issues](https://github.com/JuliaPlots/PlotlyJS.jl/issues). + This is appropriate only for bug reports or feature requests. + General usage questions should not be posted to GitHub, but rather should utilize one of the discussion forums above. ## Installation -To install `PlotlyJS.jl`, open up a Julia REPL, press `]` to enter package mode and type: +To install PlotlyJS.jl, open up a Julia REPL, press `]` to enter package mode and type: ```julia -(v1.0) pkg> add PlotlyJS +(v1.10) pkg> add PlotlyJS ``` For existing users you can run `up` from the package manager REPL mode to get the latest release. If after doing this plots do not show up in your chosen -frontend, please run `build PlotlyJS` (again from pkg REPL mode) to tell Julia -to download the latest release of the plotly.js javascript library. +front-end, please run `build PlotlyJS` (again from `pkg>` REPL mode) to tell Julia +to download the latest updates to the plotly.js JavaScript library. ### Saving figures -`PlotlyJS.jl` comes with built-in support for saving figures to files via the -integration between PlotlyBase.jl (a dependency of `PlotlyJS.jl`) and Plotly's -kaleido tool. +PlotlyJS.jl comes with built-in support for saving figures to files via the +integration between PlotlyBase.jl (a dependency of PlotlyJS.jl) and Plotly's +kaleido tool (via the PlotlyKaleido.jl package). See [exporting figures](https://juliaplots.org/PlotlyJS.jl/stable/manipulating_plots/#Saving-figures) for more information. +## Relation to Plotly.com + +This package does not interact with plotly.com or the [Plotly web API](https://api.plot.ly/v2/), +but rather leverages the underlying JavaScript library to construct plotly graphics using all local resources. +This means you do not need a Plotly account or an internet connection to use this package after installation. + ### Plots.jl If you would like to have a more exhaustive set of top-level functions for constructing plots, see the [Plots.jl](https://docs.juliaplots.org/latest/) -package. This package is the `plotlyjs` `Plots.jl` backend and is fully supported +package. This package is the `plotlyjs` backend of Plots.jl and is fully supported by Plots.