Skip to content

Commit 68b6358

Browse files
authored
feat(merge): promote develop to test (#3)
* update: editor's manual * Update deploy-docs.yml
1 parent 098fa8e commit 68b6358

File tree

2 files changed

+66
-4
lines changed

2 files changed

+66
-4
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ on:
66
- develop
77
- test
88
- main
9-
workflow_run:
10-
workflows: ["Auto Merge Approved PRs"]
11-
types:
12-
- completed
139

1410
jobs:
1511
deploy_docs:

DOCS/guidelines/editor-manual.qmd

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,72 @@ Markdown is a simple way to format text using plain characters --- no need for c
9393

9494
This section shows the most useful Markdown elements you'll need when writing documentation. If you want to explore more, visit the official [Quarto Markdown guide](https://quarto.org/docs/authoring/markdown-basics.html).
9595

96+
## Line Breaks and New Lines
97+
98+
In Markdown, how you break a line can affect how your text is displayed in the final document. Quarto follows standard Markdown behavior, so it's important to understand the difference between soft and hard line breaks.
99+
100+
### Soft Line Break (Just Pressing Enter)
101+
102+
When you press `Enter` once and start a new line in your text editor, Markdown **does not** create a visible line break in the output. Instead, it treats the two lines as part of the same paragraph.
103+
104+
Example (input):
105+
106+
```markdown
107+
This is the first line
108+
and this is the second line.
109+
```
110+
111+
Rendered output:
112+
113+
    This is the first line
114+
and this is the second line.
115+
116+
This keeps your Markdown source tidy, but it won’t create new lines unless explicitly instructed
117+
118+
### Hard Line Break (Using \ at End of Line)
119+
120+
To force a visible line break in Markdown, you must add two spaces at the end of a line or use a backslash `\`. Quarto supports both, but using `\` is clearer and more explicit.
121+
122+
```markdown
123+
This is the first line.\
124+
and this is the second line.
125+
```
126+
127+
Rendered output:
128+
129+
    This is the first line.\
130+
    and this is the second line.
131+
132+
133+
### Paragraph Break (Double Enter)
134+
135+
136+
If you press Enter twice (i.e., leave a blank line between two lines), Markdown will treat the content as two separate paragraphs. This results in a larger vertical space between the lines in the rendered output.
137+
138+
Example (input):
139+
140+
```markdown
141+
This is the first paragraph.
142+
143+
This is the second paragraph.
144+
```
145+
146+
Rendered output:
147+
148+
    This is the first paragraph.
149+
150+
    This is the second paragraph.
151+
152+
153+
This behavior is especially important when structuring readable documentation, separating ideas, or organizing content clearly.
154+
155+
### Summary
156+
157+
- Use `Enter` for a new line in your editor, but **don’t expect a visible line break**.
158+
- Use `\` at the end of a line when you want to **force a line break**.
159+
- Use **double Enter** (i.e., an empty line between paragraphs) to start a **new paragraph with extra spacing**.
160+
161+
96162
## Headings
97163

98164
Use the `#` symbol to create headings and organize your content. More `#` means a smaller heading level:

0 commit comments

Comments
 (0)