Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
a3a087b
Fix issue #1781 on doc improvements
kaixin-hc Feb 23, 2022
b6a9bcd
Make small improvements to site.json file
kaixin-hc Feb 23, 2022
c9a2306
Remove trailing spaces + inconsistent style
kaixin-hc Feb 23, 2022
4af35c5
Fix as suggested
kaixin-hc Feb 24, 2022
19d4a9a
Add dark theme example
kaixin-hc Mar 13, 2022
b794d1a
Merge branch 'master' into doc-chore
kaixin-hc Mar 13, 2022
2a274bd
Change to modal + fix spacing
kaixin-hc Mar 13, 2022
ee462e4
Revert irrelevant changes oops
kaixin-hc Mar 13, 2022
fdbe390
minimal test
jovyntls Mar 18, 2022
7508691
Working modal
jovyntls Mar 21, 2022
4107622
Fix overflow
jovyntls Mar 22, 2022
6d4b8db
Fix SSR and add zoom effect
jovyntls Mar 23, 2022
d5ab037
Remove accidental files
jovyntls Mar 23, 2022
2d272e5
Minor cleanup
jovyntls Mar 23, 2022
ccc423e
Restore deprecated modal-header and modal-footer
jovyntls Mar 23, 2022
e04d4aa
Fix tests and deprecated slots
jovyntls Mar 23, 2022
938b56a
Add tests
jovyntls Mar 23, 2022
6243e26
Upgrade Vue to v2.6.14
jovyntls Mar 23, 2022
c209f0d
Update vue-final-modal to v2.4.1
jovyntls Mar 23, 2022
87e0092
minimal
jovyntls Mar 25, 2022
70e625a
Working popovers tooltips triggers
jovyntls Mar 25, 2022
d9f1be3
Replicate existing behaviour
jovyntls Mar 25, 2022
82cff18
Replicate styles
jovyntls Mar 25, 2022
7ac6715
Fix package-lock
jovyntls Mar 25, 2022
fa1eae1
Add snapshot tests
jovyntls Mar 25, 2022
f095cb5
Update vue-components README
jovyntls Mar 25, 2022
cd596ec
Fix package-lock.json
jovyntls Mar 27, 2022
ed411d4
Update package-lock.json
jovyntls Mar 27, 2022
6622078
Fix merge mistakes
jovyntls Mar 27, 2022
696d529
Fix merge mistakes again
jovyntls Mar 27, 2022
46671fb
Remove extra eslint disable
jovyntls Mar 27, 2022
bd35db7
Update tests
jovyntls Mar 27, 2022
589b1cf
Fix test
jovyntls Mar 27, 2022
8b6415b
Fix missing modal triggers
jovyntls Mar 28, 2022
e166c57
Replicate existing tooltips
jovyntls Mar 28, 2022
3b86f5b
Linting
jovyntls Mar 28, 2022
6500e0d
Update snapshot tests
jovyntls Mar 28, 2022
efa4f04
Merge pull request #1856 from jovyntls/floating-ui-popups
ong6 Apr 1, 2022
341f118
Replace codeDarkTheme image
kaixin-hc Apr 1, 2022
de306ad
Merge branch 'master' into doc-chore
kaixin-hc Apr 1, 2022
4010d27
Fix to be same as master
kaixin-hc Apr 1, 2022
0681245
Merge
kaixin-hc Apr 1, 2022
e25de74
Merge branch 'master' into doc-chore
kaixin-hc Apr 1, 2022
6319e0b
Responsive Image
kaixin-hc Apr 18, 2022
d73e3f9
Squashed commit of the following:
kaixin-hc Apr 18, 2022
f1966f1
Follow Yongliang's overflow:hidden suggestion for resize
kaixin-hc Apr 18, 2022
ac31aa1
Merge branch 'master' into doc-chore
kaixin-hc Apr 18, 2022
52ce333
Change img to use <pic>
kaixin-hc Apr 18, 2022
ad86f06
Change image to more square one
kaixin-hc Apr 20, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/codeDarkTheme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 15 additions & 2 deletions docs/userGuide/syntax/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,20 @@

#### Themes

MarkBind can present formatted code blocks, be it fenced or inline, with either **light** or **dark** themes. The default is dark.
MarkBind can present formatted code blocks, be it fenced or inline, with either **light** or **dark** themes. The default is dark <trigger for="modal:code-dark-example" trigger="click">_(click for an example)_</trigger>.

<modal header="Dark Code Theme" id="modal:code-dark-example">

<pic src="/images/codeDarkTheme.png" alt="Theme example"></pic>
</modal>

Refer [here](../siteJsonFile.html#style) for configuring MarkBind to use a specific theme for the code blocks.

#### Fenced Code

MarkBind provides several features, some of which are added on top of the existing functionality of Markdown's _fenced code blocks_.

<small>More info: https://www.markdownguide.org/extended-syntax#fenced-code-blocks</small>
<small>More info: <https://www.markdownguide.org/extended-syntax#fenced-code-blocks></small>

Features:

Expand Down Expand Up @@ -38,6 +43,7 @@ To enable syntax coloring, specify a language next to the backticks before the f

Line numbers are <tooltip content="Line numbers were provided by default in version v3.1.1 and below. To preserve the exact line numbers behavior of sites generated in previous versions, simply set the codeLineNumbers option in site.json to true">hidden by default</tooltip>. To enable line numbers for the entire site by default,
add `"codeLineNumbers": true` to the [`site.json`]({{baseUrl}}/userGuide/siteJsonFile.html#style) file:

```json {highlight-lines="8[:]"}
{
// ...
Expand Down Expand Up @@ -120,6 +126,7 @@ public class Inventory {
return items.remove(item);
}
}

```
</variable>
</include>
Expand Down Expand Up @@ -157,6 +164,7 @@ To add a heading, add the attribute `heading` with the heading text as the value
<bar type="name">goo</bar>
</foo>
```

</variable>
</include>

Expand Down Expand Up @@ -208,6 +216,7 @@ A _wrap text_ button can be added to code blocks using the `codeBlockWrapButtons
<br>

#### Inline Code

##### Syntax coloring

MarkBind can apply syntax-coloring on inline code too.
Expand All @@ -228,17 +237,21 @@ or the java code `public static void main(String[] args)`{.java}.
</foo>
```
````

```
`<bar type="name">goo</bar>`{.xml}
```

</div>

<div id="examples" class="d-none">

```xml
<foo>
<bar type="name">goo</bar>
</foo>
```

Syntax coloring for inline code: `<bar type="name">goo</bar>`{.xml} too!

</div>