Skip to content

Commit ef3f7ad

Browse files
committed
docs wip
1 parent d8367ca commit ef3f7ad

File tree

5 files changed

+8
-5
lines changed

5 files changed

+8
-5
lines changed

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PlotlyLight.jl
1+
# Introduction
22

33
PlotlyLight.jl is a speedy lightweight interface for creating [Plotly.js](https://plotly.com/javascript/) plots from Julia.
44

docs/src/plotly_basics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Plotly.js Basics
1+
# Plotly Basics
22

33
Plotly.js is a JavaScript library that allows you to create interactive plots in the browser.
44

docs/src/saving.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Saving Plots
1+
# Saving
22

33
### Saving Plots As HTML
44

@@ -8,7 +8,9 @@ p = plot(y=rand(10))
88
PlotlyLight.save(p, "myplot.html")
99
```
1010

11-
- Note: call `PlotlyLight.preset.source.standalone!()` first if you want the html file to contain the entire plotly.js script. This enables you to view the plot even without internet access.
11+
!!! note "Standalone Source"
12+
Use `PlotlyLight.preset.source.standalone!()` before you save the plot if you want to be able view the plot without internet access. This will copy-paste the plotly.js script into the html file.
13+
1214

1315

1416
### Save Plots as Image via [PlotlyKaleido.jl](https://github.com/JuliaPlots/PlotlyKaleido.jl)

docs/src/settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ PlotlyLight.settings.div::Cobweb.Node # The plot-div
88
PlotlyLight.settings.layout::EasyConfig.Config # default `layout` for all plots
99
PlotlyLight.settings.config::EasyConfig.Config # default `config` for all plots
1010
PlotlyLight.settings.reuse_preview::Bool # In the REPL, open plots in same page (true, the default) or different pages.
11+
PlotlyLight.settings.style::Dict{String,String} # CSS styles for the plot <div>
1112
```
1213

1314
Check out e.g. `PlotlyLight.Settings().src` to examine default values.

docs/src/source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Plotly.js Source Presets
1+
# Plotly.js Source
22

33
Change how the plotly.js script gets loaded in the produced html via `preset.source.<option>!()`.
44

0 commit comments

Comments
 (0)