You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -66,7 +66,7 @@ When it's time to push updates, **only** use `include("deploy.jl")` (assuming yo
66
66
### Modifying literate scripts
67
67
68
68
1. add packages if you need additional ones (`] add ...`), make sure to update explicit compat requirements in the `Project.toml` file
69
-
1. add/modify tutorials in the `scripts/` folder
69
+
1. add/modify tutorials in the `_literate/` folder
70
70
1. to help display things neatly on the webpage (no horizontal overflow), prefer `pprint` from `PrettyPrinting.jl` to display things like `NamedTuple`
71
71
1. add `;` at the end of final lines of code blocks if you want to suppress output
72
72
@@ -99,13 +99,13 @@ The last thing to do is to add a link to the page in `_layout/head.html` so that
99
99
100
100
```julia
101
101
cd("path/to/MLJTutorials")
102
-
usingJuDoc
102
+
usingFranklin
103
103
serve()
104
104
```
105
105
106
-
If you have changed the *code* of some of the literate scripts, JuDoc will need to re-evaluate some of the code which may take some time, progress is indicated in the REPL.
106
+
If you have changed the *code* of some of the literate scripts, Franklin will need to re-evaluate some of the code which may take some time, progress is indicated in the REPL.
107
107
108
-
If you decide to change some of the code while `serve()` is running, this is fine, JuDoc will detect it and trigger an update of the relevant web pages (after evaluating the new code).
108
+
If you decide to change some of the code while `serve()` is running, this is fine, Franklin will detect it and trigger an update of the relevant web pages (after evaluating the new code).
109
109
110
110
**Notes**:
111
111
- avoid modifying the literate file, killing the Julia session, then calling `serve()` that sequence can cause weird issues where Julia will complain about the age of the world...
@@ -132,13 +132,13 @@ Do not forget to add the `# hide` which will ensure the line is not displayed on
132
132
133
133
#### Stale files
134
134
135
-
It can happen that something went wrong and you'd like to force JuDoc to re-evaluate everything to clear things up. To do this, head to the parent markdown file (e.g. `my-tutorial.md`) and add below the other ones:
135
+
It can happen that something went wrong and you'd like to force Franklin to re-evaluate everything to clear things up. To do this, head to the parent markdown file (e.g. `my-tutorial.md`) and add below the other ones:
136
136
137
137
```julia
138
138
@def reeval =true
139
139
```
140
140
141
-
save the file, wait for JuDoc to complete its update and then remove it (otherwise it will reevaluate the script every single pass which can slow things down a lot).
141
+
save the file, wait for Franklin to complete its update and then remove it (otherwise it will reevaluate the script every single pass which can slow things down a lot).
142
142
143
143
If you get an "age of the world" error, the `reeval` steps above usually works as well.
144
144
@@ -166,7 +166,7 @@ the first command will remove all stale generated HTML which may conflict with o
166
166
*Requirements*:
167
167
168
168
* admin access to the repo
169
-
*`] add Literate JuDoc NodeJS`
169
+
*`] add Literate Franklin NodeJS`
170
170
* install `highlight.js` and `gh-pages` from within Julia: ``run(`sudo $(npm_cmd()) i highlight.js gh-pages`)``
Copy file name to clipboardExpand all lines: _literate/EX-wine.jl
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
# ## Initial data processing
2
2
#
3
-
# In this example, we consider the [UCI "wine" dataset](https://archive.ics.uci.edu/ml/datasets/wine)
3
+
# In this example, we consider the [UCI "wine" dataset](http://archive.ics.uci.edu/ml/datasets/wine)
4
4
#
5
5
# > These data are the results of a chemical analysis of wines grown in the same region in Italy but derived from three different cultivars. The analysis determined the quantities of 13 constituents found in each of the three types of wines.
6
6
#
7
7
# ### Getting the data
8
-
# Let's download the data thanks to the [HTTP.jl](HTTP.get("https://archive.ics.uci.edu/ml/machine-learning-databases/wine/wine.data")) package and load it into a DataFrame via the [CSV.jl](https://github.com/JuliaData/CSV.jl) package:
8
+
# Let's download the data thanks to the [HTTP.jl](HTTP.get("http://archive.ics.uci.edu/ml/machine-learning-databases/wine/wine.data")) package and load it into a DataFrame via the [CSV.jl](https://github.com/JuliaData/CSV.jl) package:
0 commit comments