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
+55-10Lines changed: 55 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,26 +13,71 @@ To install type the following command in the Julia Pkg REPL
13
13
(v1.0) pkg> add Remark
14
14
```
15
15
16
-
Check out the [Remark docs](https://github.com/gnab/remark/wiki/Markdown) on how to write the markdown for a Remark slideshow. The most important thing is to use `---` to separate slides; an example markdown file can be found [here](https://github.com/piever/Remark.jl/blob/master/examples/example.md).
16
+
Check out the [Remark docs](https://github.com/gnab/remark/wiki/Markdown) on how to write the markdown for a Remark slideshow. The most important thing is to use `---` to separate slides; an example markdown file can be found [here](https://github.com/piever/Remark.jl/blob/master/examples/markdown/src/index.md).
17
17
18
18
```julia
19
19
import Remark
20
20
21
-
# Generate a presentation (html+markdown) from the markdown file "example.md"
22
-
# and save it in the folder "presentation/mybeautifulslides".
The `presentation` folder will also include a `make.jl` file that can be used to automatically rebuild the presentation (it is enough to `include` it).
34
+
Of course, the `make.jl` file can be customized to fit your needs, e.g., setting keyword arguments of `Remark.slideshow` or activating a `Project.toml` file for reproducibility.
31
35
32
-
- The `slideshow` command creates a slideshow that uses local javascript libraries: the resulting presentation folder can be opened offline.
36
+
It is also possible to use a julia file as a starting point (i.e., `index.jl`), thanks to the [Literate](https://github.com/fredrikekre/Literate.jl) package.
37
+
As explained in the Literate documentation, add a comment to slides corresponding to markdown. A slide separator is now `# ---` for example.
38
+
39
+
To get started, simple do:
40
+
41
+
```julia
42
+
import Remark
43
+
44
+
# Generate a presentation (html+markdown) from the julia template
If you need extra assets, simply add a `assets` folder inside `src`. It will be copied in the `build` folder automatically.
59
+
60
+
If you want to use a custom stylesheet rather than the default, simply add a `style.css` file in your `src` folder.
61
+
Your overall folder structure would be:
62
+
63
+
```
64
+
presentation/
65
+
├── src/
66
+
│ └── index.md (or .jl)
67
+
│ └── style.css
68
+
│ └── assets/
69
+
├── build/ (generated by the package)
70
+
│ └── index.html
71
+
│ └── style.css
72
+
│ └── assets/
73
+
```
33
74
34
-
- Using the [Literate](https://github.com/fredrikekre/Literate.jl) package, it is possible to create a presentation from a Julia script. As explained in the Literate documentation, add a comment to slides corresponding to markdown. A slide separator is now `# ---` for example.
75
+
The title of the presentation can be customized via the `title` keyword.
76
+
[Remark.js options](https://github.com/gnab/remark/wiki/Configuration#api) can be set using the `options` keyword.
77
+
[Documenter](https://github.com/JuliaDocs/Documenter.jl) is run on the markdown by default: to keep the markdown as is, use `documenter=false`.
35
78
36
-
-[Documenter](https://github.com/JuliaDocs/Documenter.jl) is run on the markdown by default: to keep the markdown as is, use `documenter=false`.
79
+
## Features
80
+
81
+
- The `slideshow` command creates a slideshow that uses local javascript libraries: the resulting presentation folder can be opened offline.
37
82
38
-
- All features of Documenter are automatically available here, for example use `# hide` at the end of a line of code for it to not appear in the slideshow (useful for saving plots, see [example](https://github.com/piever/Remark.jl/blob/master/examples/example.md)).
83
+
- All features of Documenter are automatically available here, for example use `# hide` at the end of a line of code for it to not appear in the slideshow (useful for saving plots, see [example](https://github.com/piever/Remark.jl/blob/master/examples/markdown/src/index.md)).
0 commit comments