Skip to content

Commit 8096da3

Browse files
committed
README update
1 parent 4cee814 commit 8096da3

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ When it's time to push updates, **only** use `include("deploy.jl")` (assuming yo
6666
### Modifying literate scripts
6767

6868
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
7070
1. to help display things neatly on the webpage (no horizontal overflow), prefer `pprint` from `PrettyPrinting.jl` to display things like `NamedTuple`
7171
1. add `;` at the end of final lines of code blocks if you want to suppress output
7272

@@ -99,13 +99,13 @@ The last thing to do is to add a link to the page in `_layout/head.html` so that
9999

100100
```julia
101101
cd("path/to/MLJTutorials")
102-
using JuDoc
102+
using Franklin
103103
serve()
104104
```
105105

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.
107107

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).
109109

110110
**Notes**:
111111
- 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
132132

133133
#### Stale files
134134

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:
136136

137137
```julia
138138
@def reeval = true
139139
```
140140

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).
142142

143143
If you get an "age of the world" error, the `reeval` steps above usually works as well.
144144

@@ -166,7 +166,7 @@ the first command will remove all stale generated HTML which may conflict with o
166166
*Requirements*:
167167

168168
* admin access to the repo
169-
* `] add Literate JuDoc NodeJS`
169+
* `] add Literate Franklin NodeJS`
170170
* install `highlight.js` and `gh-pages` from within Julia: ``run(`sudo $(npm_cmd()) i highlight.js gh-pages`)``
171171

172172
Assuming you have all that, just run

0 commit comments

Comments
 (0)