Merge pull request #521 from facultyai/julia-docs

Add Julia documentation

Author: tcbegley

README.md

@@ -55,7 +55,7 @@ conda install -c conda-forge dash-bootstrap-components
 
 ### Dash for R
 
-You can now use _dash-bootstrap-components_ with Dash for R! Note that support for Dash for R is still in beta so proceed with caution. If you try it out and run into issues, please [let us know](https://github.com/facultyai/dash-bootstrap-components/issues/new?template=bug.md)! To get started make sure you have the _devtools_ library installed
+You can now use _dash-bootstrap-components_ with Dash for R! To get started make sure you have the _devtools_ library installed
 
 ```r
 install.packages("devtools")
@@ -68,7 +68,17 @@ library(devtools)
 install_github('facultyai/dash-bootstrap-components@r-release')
 ```
 
-Check out [the docs for more details](https://dash-bootstrap-components.opensource.faculty.ai/docs/dashr)
+Check out [the docs for more details](https://dash-bootstrap-components.opensource.faculty.ai/docs/quickstart)
+
+### Dash.jl
+
+You can also use _dash-bootstrap-components_ with Dash.jl! Install with
+
+```jl
+pkg> add DashBootstrapComponents
+```
+
+Check out [the docs for more details](https://dash-bootstrap-components.opensource.faculty.ai/docs/quickstart)
 
 ## Quick start
 

docs/content/docs/dashR.md

@@ -8,6 +8,10 @@ title: Quickstart
 
 ## Installation
 
+Dash Bootstrap components can be used with Dash in Python, R or Julia.
+
+~~~bootstrap-tabs
+Python
 ### PyPI
 
 You can install _dash-bootstrap-components_ with `pip`:
@@ -24,6 +28,44 @@ conda-forge channel:
 ```sh
 conda install -c conda-forge dash-bootstrap-components
 ```
+-----
+R
+To get started make sure you have [installed Dash for R](https://dashr.plotly.com/installation). If you didn't already install it in order to install Dash for R, we also need to make sure that the _devtools_ library is installed.
+
+```r
+install.packages("devtools")
+```
+
+You can then install _dash-bootstrap-components_ from the `r-release` branch of our GitHub repository.
+
+```r
+library(devtools)
+install_github('facultyai/dash-bootstrap-components@r-release')
+```
+
+The `r-release` branch will always point to the latest R release. If you want a specific version you can install it by referencing with a tag of the form `rX.X.X` where `X.X.X` is the desired version number. For example to install version `0.10.0` you could do
+
+```r
+library(devtools)
+install_github('facultyai/dash-bootstrap-components@r0.10.0')
+```
+-----
+Julia
+To get started make sure you have [installed Dash.jl](https://dash-julia.plotly.com/installation). You can then install `DashBootstrapComponents` as follows
+
+```julia-repl
+pkg> add DashBootstrapComponents
+```
+
+Or alternatively you can install from source as follows
+
+```julia-repl
+julia> using Pkg;
+julia> Pkg.add(PackageSpec(
+           url="https://github.com/facultyai/dash-bootstrap-components", rev="julia-release",
+       ))
+```
+~~~
 
 ## Basic usage
 
@@ -38,21 +80,52 @@ To use _dash-bootstrap-components_ you must do two things:
 
 _dash-bootstrap-components_ doesn't come with CSS included. This is to give you the freedom to use any Bootstrap v4 stylesheet of your choice. This means however that in order for the components to be styled properly, you must link to a stylesheet yourself.
 
-For convenience, links to [BootstrapCDN][bootstrapcdn] for standard Bootstrap and each Bootswatch theme are available through the `themes` module, which can be used as follows:
+For convenience, links to [BootstrapCDN][bootstrapcdn] for standard Bootstrap and each Bootswatch theme are available as part of _dash-bootstrap-components_ and can be used as follows
+
+~~~bootstrap-tabs
+Python
+In Python, each CDN link is available within the `dbc.themes` submodule and can
+be used when instantiating the `app` object.
 
 ```python
 import dash
 import dash_bootstrap_components as dbc
 
 app = dash.Dash(external_stylesheets=[dbc.themes.BOOTSTRAP])
 ```
+-----
+R
+Once you have imported _dash-bootstrap-components_ with
+`library(dashBootstrapComponents)`, the `dbcThemes` list will be loaded into
+your global namespace and can be used when instantiating the `app` object.
+
+
+```r
+library(dash)
+library(dashBootstrapComponents)
+
+app <- Dash$new(external_stylesheets = dbcThemes$BOOTSTRAP)
+```
+-----
+Julia
+
+```julia
+using Dash, DashBootstrapComponents
+
+app = dash(external_stylesheets=[dbc_themes.BOOTSTRAP])
+```
+~~~
 
 For more information on available themes see the [_themes documentation_][docs-themes]
 
 ### Build the layout
 
 With CSS linked, you can start building your app's layout with our Bootstrap components. See the [_component documentation_][docs-components] for a full list of available components, or try running this minimal example to get started.
 
+~~~bootstrap-tabs
+Python
+This is a minimal Dash app written in Python.
+
 ```python
 import dash
 import dash_bootstrap_components as dbc
@@ -67,6 +140,38 @@ app.layout = dbc.Container(
 if __name__ == "__main__":
     app.run_server()
 ```
+-----
+R
+This is a minimal Dash app written in R.
+
+```r
+library(dash)
+library(dashBootstrapComponents)
+
+app <- Dash$new(external_stylesheets = dbcThemes$BOOTSTRAP)
+
+app$layout(dbcContainer(dbcAlert("Hello Bootstrap!", color = "success"),
+                        className = "p-5"))
+
+app$run_server(showcase = TRUE)
+```
+-----
+Julia
+This is a minimal Dash app written in Julia.
+
+```julia
+using Dash, DashBootstrapComponents
+
+app = dash(external_stylesheets=[dbc_themes.BOOTSTRAP])
+
+app.layout = dbc_container(
+    dbc_alert("Hello Bootstrap!", color="success"),
+    className="p-5",
+)
+
+run_server(app, "0.0.0.0", 8080)
+```
+~~~
 
 [dash-docs]: https://dash.plotly.com
 [dash-docs-external]: https://dash.plotly.com/external-resources

docs/content/docs/quickstart.md

@@ -10,9 +10,14 @@ _dash-bootstrap-components_ doesn't come with CSS included. This is to give you
 
 You can link to a stylesheet served over a CDN, or serve CSS locally depending on your needs.
 
-## The `themes` module
+## Packaged CDN links
 
-The `dash_bootstrap_components.themes` module contains links to Bootstrap and Bootswatch stylesheets hosted on [BootstrapCDN][bootstrapcdn] so you can conveniently link to one of them in your app. The easiest way to do so is to use the `external_stylesheets` argument in the `dash.Dash` constructor like this.
+_dash-bootstrap-components_ contains links to Bootstrap and Bootswatch stylesheets hosted on [BootstrapCDN][bootstrapcdn] so you can conveniently link to one of them in your app. The easiest way to do so is to use the `external_stylesheets` argument when instantiating your app.
+
+~~~bootstrap-tabs
+Python
+
+Links are available in the `dash_bootstrap_components.themes` submodule.
 
 ```python
 import dash
@@ -21,31 +26,90 @@ import dash_bootstrap_components as dbc
 app = dash.Dash(external_stylesheets=[dbc.themes.BOOTSTRAP])
 ```
 
-This will link the standard Bootstrap stylesheet. To link one of the Bootswatch styles, such as [Cyborg][bootswatch-cyborg] you would just change this to
+This will link the standard Bootstrap stylesheet. To link one of the Bootswatch styles, such as [Cyborg](https://bootswatch.com/cyborg/) you would just change this to
 
 ```python
 import dash
 import dash_bootstrap_components as dbc
 
 app = dash.Dash(external_stylesheets=[dbc.themes.CYBORG])
 ```
+-----
+R
+
+Links are available in the `dbcThemes` list which is added to your namespace when you import `dashBootstrapComponents`.
+
+```r
+library(dash)
+library(dashBootstrapComponents)
+
+app <- Dash$new(external_stylesheets = dbcThemes$BOOTSTRAP)
+```
+
+This will link the standard Bootstrap stylesheet. To link one of the Bootswatch styles, such as [Cyborg](https://bootswatch.com/cyborg/) you would just change this to
+
+```r
+library(dash)
+library(dashBootstrapComponents)
+
+app <- Dash$new(external_stylesheets = dbcThemes$CYBORG)
+```
+-----
+Julia
+
+Links are available as part of the `dbc_themes` named tuple available in `DashBootstrapComponents`.
+
+```julia
+using Dash, DashBootstrapComponents
+
+app = dash(external_stylesheets=[dbc_themes.BOOTSTRAP])
+```
+
+This will link the standard Bootstrap stylesheet. To link one of the Bootswatch styles, such as [Cyborg](https://bootswatch.com/cyborg/) you would just change this to
+
+```julia
+using Dash, DashBootstrapComponents
+
+app = dash(external_stylesheets=[dbc_themes.CYBORG])
+```
+~~~
 
 See the [available themes](#available-themes) for more.
 
 ## Manually linking to a CDN
 
-Each theme such as `dash_bootstrap_components.themes.BOOTSTRAP` is simply BootstrapCDN URL stored as a Python string, so using the themes module is really equivalent to doing something like the following.
+Each theme such as is simply a BootstrapCDN URL stored as a string, so using the themes module is really equivalent to doing something like the following.
+
+~~~bootstrap-tabs
+Python
 
 ```python
 BS = "https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css"
 app = dash.Dash(external_stylesheets=[BS])
 ```
+-----
+R
+
+```r
+BS <- "https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css"
+app <- Dash$new(external_stylesheets = BS)
+```
+-----
+Julia
+
+```julia
+BS = "https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css"
+app = dash(external_stylesheets=[BS])
+```
+~~~
 
 You can change this URL to anything you like, for example if you prefer to use a mirror or a different CDN to supply the stylesheet.
 
 ## Linking local CSS
 
-You can [download][bootstrap-download] a stylesheet and serve it locally if you prefer. This might be desirable if you are restricted by a firewall or if you want to modify the stylesheet or even [compile your own][bootstrap-compile]. The easiest way to link a local stylesheet is to place it in a folder named `assets/` in the root of the app directory. See the [Dash documentation][dash-docs-external] for more details on this.
+You can [download][bootstrap-download] a stylesheet and serve it locally if you prefer. This might be desirable if you are restricted by a firewall or if you want to modify the stylesheet or even [compile your own][bootstrap-compile]. There are tools online to help with this, we recommend [Bootstrap Build](https://bootstrap.build/app).
+
+The easiest way to link a local stylesheet is to place it in a folder named `assets/` in the root of the app directory. See the [Dash documentation][dash-docs-external] for more details on this.
 
 <h2 id="available-themes">Available themes</h2>
 
@@ -56,9 +120,8 @@ To start with, we recommend experimenting with some of the Bootswatch themes ava
 [dash-docs-external]: https://dash.plotly.com/external-resources/
 [bootstrapcdn]: https://www.bootstrapcdn.com/
 [bootstrap]:https://getbootstrap.com/
-[bootstrap-download]: https://getbootstrap.com/docs/4.4/getting-started/download/
-[bootstrap-compile]: https://getbootstrap.com/docs/4.4/getting-started/theming/
+[bootstrap-download]: https://getbootstrap.com/docs/4.6/getting-started/download/
+[bootstrap-compile]: https://getbootstrap.com/docs/4.6/getting-started/theming/
 [bootstrap-themes]: https://themes.getbootstrap.com/
 [bootswatch]: https://bootswatch.com/
-[bootswatch-cyborg]: https://bootswatch.com/cyborg/
 [bootswatch-themes]: https://www.bootstrapcdn.com/bootswatch/