Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support horizontal layout in code and output boilerplates #2194

Merged
merged 10 commits into from
Mar 7, 2023
Merged

Support horizontal layout in code and output boilerplates #2194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
acf9d62
Use codeAndOutputCode boilerplate for ug index
yucheng11122017 Mar 5, 2023
09a5a58
Change boilerplate to allow for horizontal layouts
yucheng11122017 Mar 6, 2023
e8e5fe9
Change boilerplate of codeAndOutputCode to allow horizontal output
yucheng11122017 Mar 6, 2023
95c6bfc
Change first example of code to horizontal layout
yucheng11122017 Mar 6, 2023
ee8c1e8
Remove unecessary indented class
yucheng11122017 Mar 6, 2023
1f7081b
Update documentation for variables
yucheng11122017 Mar 6, 2023
ca212e7
Add horizontal layout for codeAndOutputSeperate boilerplate
yucheng11122017 Mar 6, 2023
d91f47a
Remove uncessary linebreak
yucheng11122017 Mar 6, 2023
3357ebe
Fix typo in codeAndOutputCode
yucheng11122017 Mar 6, 2023
d0c46e5
Remove nits in code
yucheng11122017 Mar 7, 2023
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
31 changes: 30 additions & 1 deletion docs/_markbind/boilerplates/codeAndOutput.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
<!-- This boilerplate shows MarkBind code and the rendered output of that code -->
<!-- Supports 3 variables. -->
<!-- Supports 4 variables. -->
<!-- `code` - The MarkBind code content in this variable will appear in a code block containing the code, -->
<!-- and as rendered output of the code. The code cannot start or end with empty lines due to `trim` -->
<!-- `highlightStyle` (optional) - Defines the syntax coloring for the code block-->
<!-- `heading` (optional) - Heading of the code block-->
<!-- `horizontal` (optional) - If the code and output is horizontally laid out. A non-empty input will result in a horizontal layout-->

{% macro codeBox() %}
%%CODE:%%
<div class="indented">

```{{ highlightStyle | safe }}{ {% if heading %}heading="{{heading}}"{% endif %}}
{{ code | safe | trim }}
```
</div>
{% endmacro %}

{% macro outputBox() %}
%%OUTPUT:%%
<div class="indented">

Expand All @@ -21,3 +25,28 @@
{{ code | safe }}
</box>
</div>
{% endmacro %}

{% if horizontal != null %}
<div style="overflow-x: auto">
<table style="width: 100%">
<tbody>
<tr>
<td style="width: 50%">
{{ codeBox() }}
</td>
<td style="width: 50%">
{{ outputBox() }}
</td>
</tr>
</tbody>
</table>
</div>

{% else %}

{{ codeBox() }}

{{ outputBox() }}

{% endif %}
33 changes: 31 additions & 2 deletions docs/_markbind/boilerplates/codeAndOutputCode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
<!-- This boilerplate is simimlar to codeAndOuput.md but specific for fenced code syntax. -->
<!-- This boilerplate is similar to codeAndOutput.md but specific for fenced code syntax. -->
<!-- We need 4 backticks to make a fenced code block of fenced code block code -->
<!-- Syntax coloring is fixed to Markdown because it is Markdown fenced code syntax -->
<!-- Has 1 variable. -->
<!-- Has 2 variables. -->
<!-- `code` - The MarkBind code content in this variable will appear in a code block containing the code, -->
<!-- and as rendered output of the code. The code cannot start or end with empty lines due to `trim` -->
<!-- `horizontal` (optional) - If the code and output is horizontally laid out. A non-empty input will result in a horizontal layout-->

{% macro codeBox() %}
%%CODE:%%
<div class="indented">

````markdown
{{ code | safe | trim }}
````
</div>
{% endmacro %}

{% macro outputBox() %}
%%OUTPUT:%%
<div class="indented">

Expand All @@ -21,3 +25,28 @@
{{ code | safe }}
</box>
</div>
{% endmacro %}

{% if horizontal != null %}
<div style="overflow-x: auto">
tlylt marked this conversation as resolved.
Show resolved Hide resolved
<table style="width: 100%">
<tbody>
<tr>
<td style="width: 50%">
{{ codeBox() }}
</td>
<td style="width: 50%">
{{ outputBox() }}
</td>
</tr>
</tbody>
</table>
</div>

{% else %}

{{ codeBox() }}

{{ outputBox() }}

{% endif %}
31 changes: 30 additions & 1 deletion docs/_markbind/boilerplates/codeAndOutputSeparate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
<!-- This boilerplate shows MarkBind code and the rendered output of that code -->
<!-- Supports 4 variables. -->
<!-- Supports 5 variables. -->
<!-- `code` - The MarkBind code content in this variable will appear in a code block containing the code, -->
<!-- `output` - rendered output in the output box. -->
<!-- `highlightStyle` (optional) - Defines the syntax coloring for the code block-->
<!-- `heading` (optional) - Heading of the code block-->
<!-- `horizontal` (optional) - If the code and output is horizontally laid out. A non-empty input of `horizontal` will result in a horizontal layout-->

{% macro codeBox() %}
%%CODE:%%
<div class="indented">

```{{ highlightStyle | safe }}{ {% if heading %}heading="{{heading}}"{% endif %}}
{{ code | safe | trim }}
```
</div>
{% endmacro %}

{% macro outputBox() %}
%%OUTPUT:%%
<div class="indented">

Expand All @@ -21,3 +25,28 @@
{{ output | safe }}
</box>
</div>
{% endmacro %}

{% if horizontal != null %}
tlylt marked this conversation as resolved.
Show resolved Hide resolved
<div style="overflow-x: auto">
<table style="width: 100%">
<tbody>
<tr>
<td style="width: 50%">
{{ codeBox() }}
</td>
<td style="width: 50%">
{{ outputBox() }}
</td>
</tr>
</tbody>
</table>
</div>

{% else %}

{{ codeBox() }}

{{ outputBox() }}

{% endif %}
56 changes: 11 additions & 45 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,61 +31,27 @@ MarkBind extensions to Markdown | `==highlighted text==`<br>`%%grey text%%`<br>`
<panel type="seamless" header="%%More examples of generating static content%%" >

An example that uses GFMD syntax for task lists:
<div style="overflow-x: auto">

<table>
<tr>
  <td style="padding-top: 15px">

```markdown
<include src="codeAndOutput.md" boilerplate>
<variable name="highlightStyle">markdown</variable>
<variable name="horizontal" />
<variable name="code">
**Things to do:**

- [x] Finish my changes
- [ ] Push my commits to GitHub
- [ ] Open a pull request
</variable>
</include>

```
  </td>
  <td>&nbsp;→&nbsp;</td>
  <td>
<box>

**Things to do:**

- [x] Finish my changes
- [ ] Push my commits to GitHub
- [ ] Open a pull request

</box>
  </td>
</tr>
</table>

</div>

An example that uses KaTeX to generate math equations:

<div style="overflow-x: auto">

<table>
<tr>
  <td style="padding-top: 20px">

```markdown
Euler's Identity \(e^{i\pi}+1=0\) is a beautiful formula.
```
  </td>
  <td>&nbsp;→&nbsp;</td>
  <td>
<box>

<include src="codeAndOutput.md" boilerplate>
<variable name="highlightStyle">markdown</variable>
<variable name="code">
Euler's Identity \(e^{i\pi}+1=0\) is a beautiful formula.

</box>
  </td>
</tr>
</table>
</div>
</variable>
</include>

</panel>
<p/>
Expand Down