Skip to content

Commit

Permalink
Update configuration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fonsp committed Nov 30, 2021
1 parent 5068875 commit abad2ae
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/Configuration.jl
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ using FromFile
port::Integer = 2345
"""Often set to `"0.0.0.0"` on a server."""
host::Any = "127.0.0.1"
simulated_lag::Real = 0
"Besides handling slider server request, should we also run a static file server of the export output folder? Set to `false` if you are serving the HTML files in another way, e.g. using GitHub Pages, and, for some reason, you do not want to *also* serve the HTML files using this serve."
serve_static_export_folder::Bool = true
"Watch the input directory for file changes, and update the slider server sessions automatically. Only takes effect when running the slider server. More info in the README."
watch_dir::Bool = true
"Besides handling slider server request, should we also run a static file server of the export output folder? Set to `false` if you are serving the HTML files in another way, e.g. using GitHub Pages, and, for some reason, you do not want to *also* serve the HTML files using this serve."
serve_static_export_folder::Bool = true
simulated_lag::Real = 0
end

@extract_docs @option struct ExportSettings
Expand All @@ -32,22 +32,22 @@ end
exclude::Vector{String} = String[]
"List of notebook files that should always re-run, skipping the `cache_dir` system. Provide paths relative to `start_dir`."
ignore_cache::Vector = String[]
pluto_cdn_root::Union{Nothing,String} = nothing
"base64-encode the state object and write it inside the .html file. If `false`, a separate `.plutostate` file is generated. A separate statefile allows us to show a loading bar in pluto while the statefile is loading, but it can complicate setup in some environments."
baked_state::Bool = true
baked_notebookfile::Bool = true
"Hide all buttons and toolbars in Pluto to make it look like an article."
disable_ui::Bool = true
"""Show a "Run on Binder" button on the notebooks."""
offer_binder::Bool = true
"e.g. `https://mybinder.org/v2/gh/mitmath/18S191/e2dec90`. Defaults to a binder repo that runs the correct version of Pluto -- https://github.com/fonsp/pluto-on-binder. TODO docs"
binder_url::Union{Nothing,String} = nothing
"""If 1) you are using this setup to export HTML files for notebooks, AND 2) you are running the slider server **on another setup/computer**, then this setting should be the URL pointing to the slider server, e.g. `"https://sliderserver.mycoolproject.org/"`. For example, you need this if you use GitHub Actions and GitHub Pages to generate HTML files, with a slider server on DigitalOcean. === If you only have *one* server for both the static exports and the slider server, and people will read notebooks directly on your server, then the default value `nothing` will work: it will automatically make the HTML files use their current domain for the slider server."""
slider_server_url::Union{Nothing,String} = nothing
"If provided, use this directory to read and write cached notebook states. Caches will be indexed by the hash of the notebook file, but you need to take care to invalidate the cache when Pluto or this export script updates. Useful in combination with https://github.com/actions/cache, see https://github.com/JuliaPluto/static-export-template for an example."
cache_dir::Union{Nothing,String} = nothing
"Automatically generate an `index.html` file, listing all the exported notebooks (only if no `index.jl` or `index.html` file exists already)."
create_index::Bool = true
"""ADVANCED: URL of the binder repository to load when you click the "Run on binder" button in the top right, this will be set automatically if you leave it at the default value. This setting is quite advanced, and only makes sense if you have a fork of `https://github.com/fonsp/pluto-on-binder/` (because you want to control the binder launch, or because you are using your own fork of Pluto). If so, the setting should be of the form `"https://mybinder.org/v2/gh/fonsp/pluto-on-binder/v0.17.2"`, where `fonsp/pluto-on-binder` is the name of your repository, and `v0.17.2` is a tag or commit hash."""
binder_url::Union{Nothing,String} = nothing
pluto_cdn_root::Union{Nothing,String} = nothing
end

@option struct PlutoDeploySettings
Expand Down

0 comments on commit abad2ae

Please sign in to comment.