Skip to content

Commit d7af5e4

Browse files
committed
Typos in docs, update homepage
1 parent 6c21105 commit d7af5e4

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

docs/content/docs/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Or alternatively you can install from source as follows
6262
```julia-repl
6363
julia> using Pkg;
6464
julia> Pkg.add(PackageSpec(
65-
url="https://github.com/facultyai/dash-bootstrap-components", rev="jl-release"
65+
url="https://github.com/facultyai/dash-bootstrap-components", rev="julia-release",
6666
))
6767
```
6868
~~~
@@ -112,7 +112,7 @@ Julia
112112
```julia
113113
using Dash, DashBootstrapComponents
114114
115-
app = dash(external_stylesheets = [dbc_themes.BOOTSTRAP])
115+
app = dash(external_stylesheets=[dbc_themes.BOOTSTRAP])
116116
```
117117
~~~
118118

@@ -162,7 +162,7 @@ This is a minimal Dash app written in Julia.
162162
```julia
163163
using Dash, DashBootstrapComponents
164164
165-
app = dash(external_stylesheets = [dbc_themes.BOOTSTRAP])
165+
app = dash(external_stylesheets=[dbc_themes.BOOTSTRAP])
166166
167167
app.layout = dbc_container(
168168
dbc_alert("Hello Bootstrap!", color="success"),

docs/content/docs/themes.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import dash_bootstrap_components as dbc
2626
app = dash.Dash(external_stylesheets=[dbc.themes.BOOTSTRAP])
2727
```
2828
29-
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
29+
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
3030
3131
```python
3232
import dash
@@ -46,7 +46,7 @@ library(dashBootstrapComponents)
4646
app <- Dash$new(external_stylesheets = dbcThemes$BOOTSTRAP)
4747
```
4848
49-
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
49+
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
5050
5151
```r
5252
library(dash)
@@ -62,15 +62,15 @@ Links are available as part of the `dbc_themes` named tuple available in `DashBo
6262
```julia
6363
using Dash, DashBootstrapComponents
6464
65-
app = dash(external_stylesheets = [dbc_themes.BOOTSTRAP])
65+
app = dash(external_stylesheets=[dbc_themes.BOOTSTRAP])
6666
```
6767
68-
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
68+
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
6969
7070
```julia
7171
using Dash, DashBootstrapComponents
7272
73-
app = dash(external_stylesheets = [dbc_themes.CYBORG])
73+
app = dash(external_stylesheets=[dbc_themes.CYBORG])
7474
```
7575
~~~
7676

@@ -99,33 +99,29 @@ Julia
9999
100100
```julia
101101
BS = "https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css"
102-
app = dash(external_stylesheets = [BS])
102+
app = dash(external_stylesheets=[BS])
103103
```
104104
~~~
105105

106-
107106
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.
108107

109108
## Linking local CSS
110109

111-
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.
110+
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).
111+
112+
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.
112113

113114
<h2 id="available-themes">Available themes</h2>
114115

115116
There are numerous free to use Bootstrap stylesheets available on the web. The `dash_bootstrap_components.themes` module contains CDN links for Bootstrap and all of the [Bootswatch themes][bootswatch-themes]. Bootstrap also maintains its own [themes website][bootstrap-themes] which lists a number of free and premium themes that you could incorporate into your apps.
116117

117118
To start with, we recommend experimenting with some of the Bootswatch themes available in the `dash_bootstrap_components.themes` module. The full list of available themes is [`CERULEAN`](https://bootswatch.com/cerulean/), [`COSMO`](https://bootswatch.com/cosmo/), [`CYBORG`](https://bootswatch.com/cyborg/), [`DARKLY`](https://bootswatch.com/darkly/), [`FLATLY`](https://bootswatch.com/flatly/), [`JOURNAL`](https://bootswatch.com/journal/), [`LITERA`](https://bootswatch.com/litera/), [`LUMEN`](https://bootswatch.com/lumen/), [`LUX`](https://bootswatch.com/lux/), [`MATERIA`](https://bootswatch.com/materia/), [`MINTY`](https://bootswatch.com/minty/), [`PULSE`](https://bootswatch.com/pulse/), [`SANDSTONE`](https://bootswatch.com/sandstone/), [`SIMPLEX`](https://bootswatch.com/simplex/), [`SKETCHY`](https://bootswatch.com/sketchy/), [`SLATE`](https://bootswatch.com/slate/), [`SOLAR`](https://bootswatch.com/solar/), [`SPACELAB`](https://bootswatch.com/spacelab/), [`SUPERHERO`](https://bootswatch.com/superhero/), [`UNITED`](https://bootswatch.com/united/), [`YETI`](https://bootswatch.com/yeti/)
118119

119-
## Customising themes
120-
121-
Bootstrap is highly customisable, so you can also build your own stylesheet with the styles you like. There are tools online to help with this, we recommend [Bootstrap Build](https://bootstrap.build/app). If you're familiar with SASS then you can check out the [Bootstrap documentation](https://getbootstrap.com/docs/4.6/getting-started/theming/) on customisation.
122-
123120
[dash-docs-external]: https://dash.plotly.com/external-resources/
124121
[bootstrapcdn]: https://www.bootstrapcdn.com/
125122
[bootstrap]:https://getbootstrap.com/
126-
[bootstrap-download]: https://getbootstrap.com/docs/4.4/getting-started/download/
127-
[bootstrap-compile]: https://getbootstrap.com/docs/4.4/getting-started/theming/
123+
[bootstrap-download]: https://getbootstrap.com/docs/4.6/getting-started/download/
124+
[bootstrap-compile]: https://getbootstrap.com/docs/4.6/getting-started/theming/
128125
[bootstrap-themes]: https://themes.getbootstrap.com/
129126
[bootswatch]: https://bootswatch.com/
130-
[bootswatch-cyborg]: https://bootswatch.com/cyborg/
131127
[bootswatch-themes]: https://www.bootstrapcdn.com/bootswatch/

docs/templates/index.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,17 @@ <h2>Get started quickly</h2>
4242
<div class="row mt-3 mb-5">
4343
<div class="col">
4444
<p class="lead">
45-
Dash Bootstrap Components can be easily installed with
45+
Dash Bootstrap Components for Python can be easily installed with
4646
<code>pip</code> or <code>conda</code>.
4747
</p>
4848
<p class="lead">
4949
Once installed, just link a Bootstrap stylesheet and start using the
5050
components exactly like you would use other Dash component libraries.
5151
</p>
52+
<p class="lead">
53+
See the quickstart for more details, including installation
54+
instructions for R and Julia.
55+
</p>
5256
<a href="/docs/quickstart" class="btn btn-secondary">Quickstart »</a>
5357
</div>
5458
<div class="col-12 col-lg-6 mt-4 mt-lg-0">

0 commit comments

Comments
 (0)