Skip to content

Commit 40acb74

Browse files
committed
writing: updated based on PR feedback
1 parent 9933f57 commit 40acb74

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

writing/index.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -264,12 +264,10 @@ julia> Pluto.run()
264264
\tldr{Markdown is also a good fit for literate programming, and Quarto is an alternative to notebooks.}
265265

266266
[Markdown](https://www.markdownguide.org/) is a markup language used to add formatting elements to plaintext text files.
267-
For example, to bold text one encapsulates words with double asterisks: `**bold text**` -> **bold text**.
268-
Markdown files can be opened by any text editor, such as VSCode, and are particularly useful when the file itself is not the final product.
269267

270268
### Plain Text Markdown
271269
Plain text markdown files, which have the `.md` extension, are not used for interactive programming, meaning one cannot run code written in the file.
272-
Plain text markdown files are usually rendered into something else, such as but not limited to documents (e.g., PDF, Word), websites, presentations, and even books.
270+
As a result, plain text markdown files are usually rendered into a final product by other software.
273271

274272
This is an example of a plain text markdown file:
275273

@@ -290,37 +288,40 @@ println("hello world")
290288
[Quarto](https://quarto.org/) "is an open-source scientific and technical publishing system."
291289
Quarto makes a plain text markdown file (`.md`) alternative called Quarto markdown file (`.qmd`).
292290

293-
Quarto markdown files like plain text markdown files also integrate with editors, such as VSCode, and can be rendered into various output formats, such as websites.
291+
Quarto markdown files like plain text markdown files also integrate with editors, such as VSCode.
294292

295293
\vscode{
296294

297-
Install the Quarto extension for a streamlined experience.
295+
Install the Quarto [extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) for a streamlined experience.
298296

299297
}
300298

301299
Unlike plain text markdown files, Quarto markdown files have executable code chunks.
302-
These code chunks provide a functionality similar to notebooks, which makes Quarto markdown files an alternative to writing code in notebooks.
303-
Additionally, Quarto markdown files give users additional control over output and styling via YAML headers.
300+
These code chunks provide a functionality similar to notebooks, thus Quarto markdown files are an alternative to notebooks.
301+
Additionally, Quarto markdown files give users additional control over output and styling via the YAML header at the top of the `.qmd` file.
304302

305-
Below is a revised markdown example using Quarto.
306-
If this file were opened in an editor such as VSCode one could execute the `println("hello world")` Julia code and view the output.
307-
Also, notice the YAML header at the top of the page that defines the document's title and specifies to make the code chunks invisible via the `echo: false` command.
308-
When `echo` is set to `false` the output of the code chunks will be displayed but the code itself will be hidden.
309-
310-
Last, as of Quarto version 1.5, Julia programmers have the option to use a native Julia engine to execute code - previously IJulia.jl was the only Julia engine.
311-
The primary difference betweens IJulia.jl and the native Julia engine is that the native Julia engine does not depend on Python and can utilize local environments.
303+
As of Quarto version 1.5, users can choose from two Julia engines to execute code - a native Julia engine and IJulia.jl.
304+
The primary difference between the native Julia engine and IJulia.jl is that the native Julia engine does not depend on Python and can utilize local environments.
305+
For this reason it's recommended to start with the native Julia engine.
312306
Learn more about the native Julia engine in Quarto's [documentation](https://quarto.org/docs/blog/posts/2024-07-11-1.5-release/#native-julia-engine).
313-
To use the native Julia engine set `engine` equal to `julia` in the YAML header of the Quarto markdown file as seen below.
307+
308+
Below is an example of a Quarto markdown file.
314309

315310
````quarto
316311
---
317312
title: "My document"
318313
format:
314+
# renders a HTML document
319315
html:
316+
# table of contents
320317
toc: true
321318
execute:
319+
# makes code chunks invisible in the output
320+
# code output is still visible though
322321
echo: false
322+
# hides warnings in the output
323323
warning: false
324+
# native julia engine
324325
engine: julia
325326
---
326327
@@ -330,6 +331,8 @@ engine: julia
330331
331332
Below is an executable code chunk.
332333
334+
If this file were opened in an editor such as VSCode one could execute the `println("hello world")` Julia code and view the output, like in a notebook.
335+
333336
```{{julia}}
334337
println("hello world")
335338
```

0 commit comments

Comments
 (0)