Skip to content

Commit 0e37eaf

Browse files
authored
Fix unexpected behavior in UG due to invalid HTML markup (#1837)
Invalid HTML markup may cause Vue hydration issues. Let's replace span tags with div tags to avoid invalid inclusion of block-level elements in span tags. This prevents possible errors in HTML syntax.
1 parent abcf656 commit 0e37eaf

60 files changed

Lines changed: 315 additions & 249 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/_markbind/layouts/userGuide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
* [Syntax Cheat Sheet]({{baseUrl}}/userGuide/syntaxCheatSheet.html)
3939
* [`site.json` File]({{baseUrl}}/userGuide/siteJsonFile.html)
4040
* [Tips & Tricks]({{baseUrl}}/userGuide/tipsAndTricks.html)
41+
* [Troubleshooting]({{baseUrl}}/userGuide/troubleshooting.html)
4142
* [Glossary]({{baseUrl}}/userGuide/glossary.html)
4243
</site-nav>
4344
</div>

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66

77
<h1 class="display-3"><md>**MarkBind**</md></h1>
88

9-
<span class="lead">
9+
<div class="lead">
1010

1111
++**Generate <tooltip content="as opposed to _one-size-fits-all_ static content">_more dynamic_</tooltip> websites from Markdown text.**++
1212
Optimized for creating text-heavy websites %%e.g., eLearning websites, online instruction manuals, project documentation etc.%%
13-
</span>
13+
</div>
1414

1515
<a class="btn btn-primary" href="userGuide/">Get Started</a>
1616

docs/userGuide/addingPages.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@
1414

1515
# {{ title }}
1616

17-
<span class="lead" id="overview">
17+
<div class="lead" id="overview">
1818

1919
**It is easy to add files to a MarkBind site as any file inside the {{ tooltip_root_directory }} becomes a part of the generated website.**
2020

21-
</span>
21+
</div>
2222

2323
<div class="indented">
2424

docs/userGuide/components/imagesAndDiagrams.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616

1717
# Image & Diagram Components
1818

19-
<span id="overview" class="lead">
19+
<div id="overview" class="lead">
2020

2121
The image components here provide **convenient syntax & styling abstractions** on top of raw HTML and Markdown images.
2222
Diagrams, in the form of **inline PlantUML components** are also supported.
23-
</span>
23+
</div>
2424

2525
{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}
2626

docs/userGuide/components/others.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616

1717
# Other Components
1818

19-
<span id="overview" class="lead">
19+
<div id="overview" class="lead">
2020

2121
This page lists some other components that may be useful in creating education websites. For now, there are only question and quiz components.
22-
</span>
22+
</div>
2323

2424
{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}
2525

docs/userGuide/components/popups.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616

1717
# Pop-Up Components
1818

19-
<span id="overview" class="lead">
19+
<div id="overview" class="lead">
2020

2121
The components in this page can be used to easily create **various forms of pop-ups** that are activated on some user action (e.g., hovering over some text). This may be useful for showing additional information related to some specific area or span of content.
22-
</span>
22+
</div>
2323

2424
{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}
2525

docs/userGuide/components/presentation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616

1717
# Presentational Components
1818

19-
<span id="overview" class="lead">
19+
<div id="overview" class="lead">
2020

2121
The components in this page are the core **presentational** components you may want to use. Panels and tabs can be used to **organise content sections**, while badges and boxes can **highlight small, specific pieces of information**.
22-
</span>
22+
</div>
2323

2424
{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}
2525

docs/userGuide/deployingTheSite.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414

1515
# {{ title }}
1616

17-
<span class="lead" id="overview">
17+
<div class="lead" id="overview">
1818

1919
**A site generated by MarkBind can be deployed by simply uploading the generated files to any Web server.** In addition, MarkBind provides several convenient deployment options.
20-
</span>
20+
</div>
2121

2222
## Generic steps for deploying a MarkBind site
2323

docs/userGuide/formattingContents.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@
1414

1515
# {{ title }}
1616

17-
<span class="lead" id="overview">
17+
<div class="lead" id="overview">
1818

1919
**MarkBind supports a wide collection of Markdown-like basic content formatting syntax** such as text styling, tables, lists, images, links, etc.
2020

21-
</span>
21+
</div>
2222

2323
{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}
2424

docs/userGuide/glossary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
#### Live Preview <span style="font-size: 0.8em;">:fas-sync:</span>
77

8-
<span id="live-preview">
8+
<div id="live-preview">
99

1010
**_Live preview_** is:
1111
- Regeneration of affected content upon any change to <tooltip content="`.md`, `.njk` files ... anything your content depends on!">source files</tooltip>, then reloading the updated site in the Browser.
@@ -16,4 +16,4 @@
1616

1717
Use [the `serve` command](cliCommands.html#serve-command) to launch a live preview.
1818

19-
</span>
19+
</div>

0 commit comments

Comments
 (0)