Skip to content

Commit 5244e00

Browse files
committed
writing: index: created a new section called Markdown with two sub-headers (plain text markdown and quarto)
1 parent 2a84c99 commit 5244e00

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

writing/index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,49 @@ julia> using Pluto
259259
julia> Pluto.run()
260260
```
261261

262+
## Markdown
263+
264+
\tldr{Markdown is also a good fit for literate programming.}
265+
266+
[Markdown](https://www.markdownguide.org/) can be an alternative to writing code in notebooks (such as Jupyter), and is particularly useful when the file itself is not the final product, which is a key element of literate programming. Markdown is a markup language used to add formatting elements to plaintext text files, for example to bold text one would write `**bold words**`. Markdown is portable so it can be opened by any text editor, such as VSCode.
267+
268+
### Plain Text Markdown
269+
Plain text markdown files, which have the `.md` extension, are not used for interactive programming, meaning one cannot run code written in the file.
270+
Plain text markdown files are not an alternative to writing code in notebooks.
271+
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.
272+
273+
This is an example of a plain text markdown file:
274+
275+
````markdown
276+
# Title
277+
278+
## Section Header
279+
280+
This is example text.
281+
282+
```julia
283+
println("hello world")
284+
```
285+
````
286+
287+
### Quarto
288+
289+
An alternative to `.md` markdown files are Quarto markdown files (`.qmd`).
290+
[Quarto](https://quarto.org/) is an open-source scientific and technical publishing system.
291+
292+
Unlike plain text `.md` markdown files, Quarto markdown files offer several advantages.
293+
In regards to writing code, the primary advantage is executable code cells/ chunks.
294+
In this fashion, Quarto markdown files are an alternative to writing code in notebooks (such as Jupyter).
295+
Quarto markdown files can also be rendered into the aforementioned output formats.
296+
297+
If the above example of a plain text markdown file were instead a Quarto markdown file, then within the editor, VSCode for example, one would be able to execute the `println("hello world")` Julia code and view the output.
298+
299+
\vscode{
300+
301+
Install the Quarto extension for a streamlined experience.
302+
303+
}
304+
262305
## Environments
263306

264307
\tldr{Activate a local environment for each project with `]activate path`. Its details are stored in `Project.toml` and `Manifest.toml`.}

0 commit comments

Comments
 (0)