Skip to content

Convert to code block #1086

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

Merged
marvinchin merged 36 commits into from
Mar 16, 2020
Merged

Convert to code block #1086

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
538ff88
add _site to ignore list
Tejas2805 Feb 16, 2020
52e1afa
update highlighted text bg color
Tejas2805 Feb 17, 2020
f3d3f34
Merge branch 'master' of https://github.com/MarkBind/markbind
Tejas2805 Feb 27, 2020
5738a2b
add <hr> to code
Tejas2805 Feb 27, 2020
145b97c
update
Tejas2805 Feb 27, 2020
7132f95
add <br> to output
Tejas2805 Feb 27, 2020
d5b91ff
add <br> to code
Tejas2805 Feb 27, 2020
27c11d7
update to make it consistent
Tejas2805 Feb 27, 2020
34d2563
correct input indentation
Tejas2805 Feb 27, 2020
f64773a
update
Tejas2805 Feb 27, 2020
8b5e5d9
update code to code blocks
Tejas2805 Feb 28, 2020
8ef5aa5
Update siteNavigationMenus.mbdf
Tejas2805 Feb 28, 2020
45331b0
Update siteNavigationMenus.mbdf
Tejas2805 Feb 28, 2020
5f0a6ab
Update docs/userGuide/syntax/siteNavigationMenus.mbdf
Tejas2805 Mar 1, 2020
cd3e2de
Update siteNavigationMenus.mbdf
Tejas2805 Mar 1, 2020
3cc213d
Update horizontal rules link to same page
Tejas2805 Mar 2, 2020
ba9078f
add hr to code and output
Tejas2805 Mar 4, 2020
db6399c
use code blocks in pageHeader
Tejas2805 Mar 4, 2020
88ff2de
add highlighting
Tejas2805 Mar 4, 2020
d5b928e
update siteNav to code block
Tejas2805 Mar 4, 2020
9720d63
improve readability
Tejas2805 Mar 4, 2020
a5c6f32
Merge branch 'master' of https://github.com/MarkBind/markbind into co…
Tejas2805 Mar 7, 2020
fcbeb2a
update code blocks with headings
Tejas2805 Mar 7, 2020
759d1ca
Update pageHead.mbdf
Tejas2805 Mar 7, 2020
989eb48
update
Tejas2805 Mar 7, 2020
a2e7043
update
Tejas2805 Mar 7, 2020
3cc4bd4
update files
Tejas2805 Mar 7, 2020
174af21
remove commas
Tejas2805 Mar 10, 2020
9bf9180
Update pageLayouts.mbdf
Tejas2805 Mar 12, 2020
76a3d4f
Update pageHead.mbdf
Tejas2805 Mar 12, 2020
f6249aa
Update pageLayouts.mbdf
Tejas2805 Mar 12, 2020
555bd9d
Update pageLayouts.mbdf
Tejas2805 Mar 12, 2020
5adc1ea
Update pageLayouts.mbdf
Tejas2805 Mar 12, 2020
1442e8d
Update pageLayouts.mbdf
Tejas2805 Mar 13, 2020
3b7b526
add todo comment and explanation
Tejas2805 Mar 13, 2020
7b1d9a8
Update pageLayouts.mbdf
Tejas2805 Mar 14, 2020
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
8 changes: 2 additions & 6 deletions docs/userGuide/plugins/filterTags.mbdf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,7 @@ Using `-` at the start of a tag hides all tags matching the expression. This is
<div class="indented">

{{ icon_example }} Using general tags:
```html
index.md

```html {heading="index.md"}
<frontmatter>
title: "Hello World"
tags: ["language--java"]
Expand All @@ -123,9 +121,7 @@ index.md
<p tags="language--python">print("Hello world")</p>
```

```json
site.json

```json {heading="site.json"}
{
...
"plugins" : [
Expand Down
44 changes: 19 additions & 25 deletions docs/userGuide/syntax/pageHead.mbdf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,11 @@ Steps:

{{ icon_example }} Suppose you want to insert the code below into the `<head>` of a page, and you have saved the code as **`_markbind/head/`**`myCustomLinks.md`:

<box>

`<script src="`{{ showBaseUrlCode }}`/js/myCustomScript.js"></script>`<br>
`<link rel="stylesheet" href="`{{ showBaseUrlCode }}`/css/main.css">`<br>
`<link rel="stylesheet" href="`{{ showBaseUrlCode }}`/css/extra.css">`

</box>
```html{.no-line-numbers}
<script src="{{ baseUrl }}/js/myCustomScript.js"></script>
<link rel="stylesheet" href="{{ baseUrl }}/css/main.css">
<link rel="stylesheet" href="{{ baseUrl }}/css/extra.css">
```

To specify that you want to insert `myCustomLinks.md` into the `<head>` of `myPage.html`, update the front matter of the `myPage.md` as follows:
```html
Expand All @@ -34,15 +32,13 @@ To specify that you want to insert `myCustomLinks.md` into the `<head>` of `myPa

{{ icon_example }} Here's how you can force the line `<script ... > ... </script>` to be inserted at the top of the `<head>` section.

<box>

**`<head-top>`**<br>
&nbsp;&nbsp;`<script src="`{{ showBaseUrlCode }}`/js/myCustomScript.js"></script>`<br>
**`</head-top>`**<br>
`<link rel="stylesheet" href="`{{ showBaseUrlCode }}`/css/main.css">`<br>
`<link rel="stylesheet" href="`{{ showBaseUrlCode }}`/css/extra.css">`

</box>
```html {.no-line-numbers highlight-lines="1,3"}
<head-top>
<script src="{{ baseUrl }}/js/myCustomScript.js"></script>
</head-top>
<link rel="stylesheet" href="{{ baseUrl }}/css/main.css">
<link rel="stylesheet" href="{{ baseUrl }}/css/extra.css">
```

</div>

Expand All @@ -62,15 +58,13 @@ To specify that you want to insert `myCustomLinks.md` into the `<head>` of `myPa

`_markbind/head/myCustomLinks.md`:

<box>

**`<head-top>`**<br>
&nbsp;&nbsp;`<script src="`{{ showBaseUrlCode }}`/js/myCustomScript.js"></script>`<br>
**`</head-top>`**<br>
`<link rel="stylesheet" href="`{{ showBaseUrlCode }}`/css/main.css">`<br>
`<link rel="stylesheet" href="`{{ showBaseUrlCode }}`/css/extra.css">`

</box>
```html{.no-line-numbers highlight-lines="1,3"}
Comment thread
Tejas2805 marked this conversation as resolved.
<head-top>
<script src="`{{ baseUrl }}`/js/myCustomScript.js"></script>
</head-top>
<link rel="stylesheet" href="`{{ baseUrl }}`/css/main.css">
<link rel="stylesheet" href="`{{ baseUrl }}`/css/extra.css">
```

```html
<frontmatter>
Expand Down
20 changes: 7 additions & 13 deletions docs/userGuide/syntax/pageLayouts.mbdf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!---
TODO: Change to a proper escape tag once PR#1049 is ready.
-->
<variable name="mainContentBody">
<code>{<span></span>{ MAIN_CONTENT_BODY }}</code>
</variable>
Expand All @@ -11,7 +14,7 @@ A layout consists of the following files:
1. A footer (filename: `footer.md`)
1. Tweaks to the `<head>` (`head.md`)
1. A site navigation menu (`navigation.md`)
1. An expressive layout template to embed your content (`page.md`)
1. An expressive layout template to embed your content (`page.md`)
1. Custom styles (`styles.css`)
1. Custom scripts (`scripts.js`)

Expand Down Expand Up @@ -114,27 +117,18 @@ which injects the actual page content in every page. This allows you to build la

{{ icon_example }} Adding statistics formula to the bottom of every page

<box>
<i>index.md</i>
<br><br>

```html
```html {heading="index.md"}
#### Main content of your page

Content of your page
```
</box>

<box>
<i>page.md</i>
<br><br>
{{ mainContentBody }}
```html
```html {heading="page.md"}
{{ mainContentBody }}
<panel header="Statistics Formula for the class" type="primary">
<img src="path_to_your_formula.png" />
</panel>
```
</box>

Here's how the above content would appear:

Expand Down
45 changes: 21 additions & 24 deletions docs/userGuide/syntax/siteNavigationMenus.mbdf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,19 +72,17 @@ You may have additional HTML and Markdown content in a <tooltip content="the fil

{{ icon_example }} A siteNav code using a `<navigation>` tag.

<box>

<code>
# Site Map<br>
<strong><<span></span>navigation></strong><br>
* [:house: Home]({{ showBaseUrlText }}/index.html)<br>
* Docs<br>
&nbsp;&nbsp;* [User Guide]({{ showBaseUrlText }}/ug.html)<br>
&nbsp;&nbsp;* [Dev Guide]({{ showBaseUrlText }}/dg.html)<br>
* [Search]({{ showBaseUrlText }}/search.html)<br>
<strong><<span></span>/navigation></strong><br>
</code>
</box>
```{.no-line-numbers}
# Site Map
<navigation>
* [:house: Home]({{ baseUr }}/index.html)
* Docs
* [User Guide]({{ baseUrl }}/ug.html)
* [Dev Guide]({{ baseUrl }}/dg.html)
* [Search]({{ baseUrl }}/search.html)
</navigation>
```

</div>

More than one siteNav file can be in `_markbind/navigation/` directory but a page may not have more than one siteNav.
Expand All @@ -98,17 +96,16 @@ If you wish to use a Layout but exclude its navigation file, specify `siteNav: n

<span id="short" class="d-none">

<code>
# Site Map<br>
<strong><<span></span>navigation></strong><br>
* [:house: Home]({{ showBaseUrlText }}/index.html)<br>
* Docs :expanded:<br>
&nbsp;&nbsp;* [User Guide]({{ showBaseUrlText }}/ug.html)<br>
&nbsp;&nbsp;* [Dev Guide]({{ showBaseUrlText }}/dg.html)<br>
* [Search]({{ showBaseUrlText }}/search.html)<br>
<strong><<span></span>/navigation></strong><br>
</code>
</box>
```{.no-line-numbers}
# Site Map
<navigation>
* [:house: Home]({{ baseUrl }}/index.html)
* Docs :expanded:
* [User Guide]({{ baseUrl }}/ug.html)
* [Dev Guide]({{ baseUrl }}/dg.html)
* [Search]({{ baseUrl }}/search.html)
</navigation>
```

```html
<frontmatter>
Expand Down