From 4ca21909c413fdeab0b920859e2c35dd9eb8be89 Mon Sep 17 00:00:00 2001
From: Josh Day <emailjoshday@gmail.com>
Date: Fri, 17 May 2024 15:59:01 -0400
Subject: [PATCH] move all readme docs to documenter

---
 README.md    | 106 ---------------------------------------------------
 docs/make.jl |   3 ++
 2 files changed, 3 insertions(+), 106 deletions(-)

diff --git a/README.md b/README.md
index 306c020..a9ab041 100644
--- a/README.md
+++ b/README.md
@@ -34,109 +34,3 @@ p  # `display(p)` to see the updated plot
 <p align="center">
     <img width=650 src="https://user-images.githubusercontent.com/8075494/213164013-3ba1a108-122a-4339-a0a2-fa2175fa06e3.png">
 </p>
-
-<br><br>
-
-## 📈 Traces
-
-- A core concept in Plotly is that of a *trace*, which is the data along with specifications on how to plot it.
-- There are many different trace *types* (e.g. "scatter" for scatterplots, "box" for boxplots).
-
-
-PlotlyLight does some simple "tricks" with the `plot` function so that:
-
-```julia
-plot.trace(; kw...) == plot(; type=trace, kw...)
-```
-
-**This lets you tab-autocomplete the trace type:**
-
-```julia
-julia> plot.<TAB>
-# bar                 barpolar            box                 candlestick
-# carpet              choropleth          choroplethmapbox    cone
-# contour             contourcarpet       densitymapbox       funnel
-# funnelarea          heatmap             heatmapgl           histogram
-# histogram2d         histogram2dcontour  icicle              image
-# indicator           isosurface          mesh3d              ohlc
-# parcats             parcoords           pie                 pointcloud
-# sankey              scatter             scatter3d           scattercarpet
-# scattergeo          scattergl           scattermapbox       scatterpolar
-# scatterpolargl      scattersmith        scatterternary      splom
-# streamtube          sunburst            surface             table
-# treemap             violin              volume              waterfall
-```
-
-**You can chain the dot syntax to add traces to a plot, e.g.**
-
-```julia
-y = randn(20)
-
-plot.bar(; y).scatter(; y)
-```
-
-<br><br>
-
-## 📄 Saving Plots
-
-### Saving Plots As HTML
-
-```julia
-p = plot(y=rand(10))
-
-PlotlyLight.save(p, "myplot.html")
-```
-
-- Note: call `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.
-
-
-### Save Plots as Image via [PlotlyKaleido.jl](https://github.com/JuliaPlots/PlotlyKaleido.jl)
-
-```julia
-using PlotlyKaleido
-
-PlotlyKaleido.start()
-
-(;data, layout, config) = p
-
-PlotlyKaleido.savefig((; data, layout, config), "myplot.png")
-```
-
-<br><br>
-
-## 🎛️ Presets
-
-### Theme Presets
-
-Set a theme/template via `preset.template.<option>!()`.  Note that options are tab-autocomplete-able.  These are borrowed from the [built-in themes](https://plotly.com/python/templates/) in the plotly python package.
-
-```julia
-preset.template.ggplot2!()
-```
-
-### Source Presets
-
-Change how the plotly.js script gets loaded in the produced html via `preset.source.<option>!()`.
-
-```julia
-preset.source.none!()       # Don't include the script.
-preset.source.cdn!()        # Use the official plotly.js CDN.
-preset.source.local!()      # Use a local version of the plotly.js script.
-preset.source.standalone!() # Copy-paste the plotly.js script into the html output.
-```
-
-<br><br>
-
-## ⚙️ Settings
-
-Occasionally `preset`s aren't enough.  Lower level user-configurable settings are available in `PlotlyLight.settings`:
-
-```julia
-PlotlyLight.settings.src::Cobweb.Node           # plotly.js script loader
-PlotlyLight.settings.div::Cobweb.Node           # The plot-div
-PlotlyLight.settings.layout::EasyConfig.Config  # default `layout` for all plots
-PlotlyLight.settings.config::EasyConfig.Config  # default `config` for all plots
-PlotlyLight.settings.reuse_preview::Bool        # In the REPL, open plots in same page (true, the default) or different pages.
-```
-
-Check out e.g. `PlotlyLight.Settings().src` to examine default values.
diff --git a/docs/make.jl b/docs/make.jl
index 82edb96..0451b9b 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -11,6 +11,9 @@ makedocs(
         "index.md",
         "plotly_basics.md",
         "templates.md",
+        "saving.md",
+        "source.md",
+        "settings.md",
     ]
 )