Convert to code block #1086

Tejas2805 · 2020-03-04T09:51:21Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [x] Documentation update

What is the rationale for this request?
Recommended by @nbriannl in PR #1063

What changes did you make? (Give an overview)
Changed <code> to using code blocks

Provide some example code that this change will affect:
N.A.

Testing instructions:
Can check the preview.

Proposed commit message: (wrap lines at 72 characters)

Let's convert <code> boxes to code blocks  to better showcase the 
feature

* 'master' of https://github.com/MarkBind/markbind: Update tests Allow using 'none' footer attribute in frontmatter (MarkBind#1002) Support line numbers for code blocks (MarkBind#991) 2.11.0 Update test files due to changes in PR MarkBind#982 Update vue-strap version to v2.0.1-markbind.36 Make highlighting bold (MarkBind#1045) Support markdown for header attr in dropdown (MarkBind#1029) Add '_site' to the ignored folders in site.json (MarkBind#1046) Use path.join instead of string interpolation (MarkBind#1052) Implement box markdown header attributes parsing (MarkBind#1025) Make the position of top navbar fixed (MarkBind#982) Exclude *.md files from being copied over on build (MarkBind#1010) # Conflicts: # docs/css/main.css

Co-Authored-By: nbriannl <neilbrian.nl@gmail.com>

…nvert-to-code-block * 'master' of https://github.com/MarkBind/markbind: Allow changing parameter properties (MarkBind#1075) Custom timezone for built-in timestamp (MarkBind#1073) Fix reload inconsistency when updating frontmatter (MarkBind#1068) Implement an api to ignore content in certain tags (MarkBind#1047) Enable AppVeyor CI (MarkBind#1040) Add heading and line highlighting to code blocks (MarkBind#1034) Add dividers and fix bug in siteNav (MarkBind#1063) Fixed navbar no longer covers modals (MarkBind#1070) Add copy code-block plugin (MarkBind#1043) Render plugins on dynamic resources (MarkBind#1051) Documentation for Implement no-* attributes for <box> (MarkBind#1042) Migrate to bootstrap-vue popovers (MarkBind#1033) Refactor preprocess and url processing functions (MarkBind#1026) Add pageNav to Using Plugins Page (MarkBind#1062) # Conflicts: # docs/userGuide/syntax/siteNavigationMenus.mbdf

Tejas2805 · 2020-03-07T23:48:03Z

@nbriannl Can I get your review on this?

Tejas2805 · 2020-03-09T15:34:32Z

@marvinchin Can I get your review on this? Thank you for your time.

Tejas2805 · 2020-03-10T08:51:25Z

@nbriannl Can I get your review on this?

nbriannl · 2020-03-10T13:20:35Z

This PR fixes #1091

Note to self and others reviewers: The changes to the files are reflected in the following pages
https://deploy-preview-1086--markbind-master.netlify.com/userguide/usingplugins#filtertags-toggling-alternative-contents-in-a-page
https://deploy-preview-1086--markbind-master.netlify.com/userguide/tweakingthepagestructure#page-and-lt-head-and-gt
https://deploy-preview-1086--markbind-master.netlify.com/userguide/tweakingthepagestructure#page-layouts
https://deploy-preview-1086--markbind-master.netlify.com/userguide/tweakingthepagestructure#site-navigation-menus

nbriannl

Thank you, with these we no longer use <code> in these following pages
https://deploy-preview-1086--markbind-master.netlify.com/userguide/tweakingthepagestructure
https://deploy-preview-1086--markbind-master.netlify.com/userguide/usingplugins

LGTM.

marvinchin

Please also link the issue you are fixing in the PR description. This allows github to automatically close the issue when this is merged.

docs/userGuide/syntax/pageHead.mbdf

marvinchin · 2020-03-11T06:24:23Z

docs/userGuide/syntax/pageLayouts.mbdf

-  {{ mainContentBody }}
-  ```html
+  ```html {heading="page.md", highlight-lines="1"}
+     MAIN_CONTENT_BODY


I think this should be a variable. (previously this was {{ mainContentBody }})

When I am putting is a variable this is how it gets rendered

How do you want me to implement it?

Seems like we would need to be able to escape the variable in the code block in order to render it as is rather than replace it with the actual value.

There is a PR that aims to address this (#1049) but I haven't had the time to review that yet.

Alternatively, we could do a dirty hack and use the zero width space to break up the variable syntax when declaring the mainContentBody variable:

<variable name="mainContentBody"> {{ MAIN_CONTENT_BODY }} </variable>

If we do this, we should leave a todo reminding us to change it to use the escape tags once that PR is ready.

I'd lean towards the latter, so we can make a clean move towards code blocks and avoid any potential merge conflicts if there are any new changes to the documentation, since I'm not sure when that PR is going to be merged.

Okay will do accordingly.

marvinchin · 2020-03-12T18:29:15Z

docs/userGuide/syntax/pageLayouts.mbdf

-  {{ mainContentBody }}
-  ```html
+  ```html {heading="page.md"}
+    <variable name="mainContentBody">


No, I didn't mean to insert this here 😅 If you look at the top of this file, there is a variable declared for mainContentBody, and the value is substituted whenever we use the variable by writing {{ mainContentBody }}. We should change the value of the variable, and continue to use the variable here.

Aah sorry. Didn't realise there was a variable declared on top of the file. Thanks for guiding.

Also, can you help explain what does &#8203 do?

It's the unicode for zero width space. This allows us to break up the {{ variable }} syntax and avoid markbind from treating it as a variable.

https://www.fileformat.info/info/unicode/char/200b/index.htm

Let's also leave a comment explaining why we are doing this.

Please also leave a TODO to remind us to change to a proper escape tag once #1049 is ready.

marvinchin

Sorry, found an issue with the zero width space hack that I suggested. Let's revert the changes for that file for now. We should be good to go once we have changed that.

I think this also presents a compelling use case for #1049.

marvinchin · 2020-03-14T06:14:46Z

docs/userGuide/syntax/pageLayouts.mbdf

 <variable name="mainContentBody">
-<code>{<span></span>{ MAIN_CONTENT_BODY }}</code>
+{&#8203;{ MAIN_CONTENT_BODY }}


Ah I didn't realise this earlier, but the zero width space is preserved when the user copies the text from the page. This would cause the snippet to not work if the user copies and pastes it into their own editor.

Let's revert back to the original version for the segments that require this variable, and leave a todo for us to change it once the escape tags PR is ready.

Done. We should be good to go, I guess.

marvinchin

LGTM

* 'master' of https://github.com/MarkBind/markbind: Convert code in boxes to code block (MarkBind#1086)

…x-pageNav * 'master' of https://github.com/MarkBind/markbind: Update test files (MarkBind#1138) Remove OK button from modals (MarkBind#1134) Add start from line number functionality to code blocks (MarkBind#1115) Allow special tags to be self-closing (MarkBind#1101) Simplify baseUrl resolving process (MarkBind#1087) Remove redundant file writing (MarkBind#1090) Bump acorn from 5.7.3 to 5.7.4 (MarkBind#1121) Bump acorn from 7.1.0 to 7.1.1 in /src/lib/markbind (MarkBind#1120) Unify markdown-it parser variants (MarkBind#1056) Remove dynamic include feature (MarkBind#1037) Fix flex shrink not applying in content wrapper (MarkBind#1135) Escape Nunjucks for special tags (MarkBind#1049) Update documentation on icon slot for boxes (MarkBind#1123) Convert code in boxes to code block (MarkBind#1086)

Let's convert <code> boxes to code blocks to better showcase the feature

Tejas2805 and others added 27 commits February 17, 2020 04:54

add _site to ignore list

538ff88

update highlighted text bg color

52e1afa

add <hr> to code

5738a2b

update

145b97c

add <br> to output

7132f95

add <br> to code

d5b91ff

update to make it consistent

27c11d7

correct input indentation

34d2563

update

f64773a

update code to code blocks

8b5e5d9

Update siteNavigationMenus.mbdf

8ef5aa5

Update siteNavigationMenus.mbdf

45331b0

Update docs/userGuide/syntax/siteNavigationMenus.mbdf

5f0a6ab

Co-Authored-By: nbriannl <neilbrian.nl@gmail.com>

Update siteNavigationMenus.mbdf

cd3e2de

Update horizontal rules link to same page

3cc213d

add hr to code and output

ba9078f

use code blocks in pageHeader

db6399c

add highlighting

88ff2de

update siteNav to code block

d5b928e

improve readability

9720d63

update code blocks with headings

fcbeb2a

Update pageHead.mbdf

759d1ca

update

989eb48

update

a2e7043

update files

3cc4bd4

Tejas2805 marked this pull request as ready for review March 8, 2020 09:19

remove commas

174af21

nbriannl approved these changes Mar 10, 2020

View reviewed changes

marvinchin requested changes Mar 11, 2020

View reviewed changes

Tejas2805 added 4 commits March 12, 2020 17:54

Update pageLayouts.mbdf

9bf9180

Update pageHead.mbdf

76a3d4f

Update pageLayouts.mbdf

f6249aa

Update pageLayouts.mbdf

555bd9d

marvinchin requested changes Mar 12, 2020

View reviewed changes

Tejas2805 and others added 3 commits March 13, 2020 07:14

Update pageLayouts.mbdf

5adc1ea

Update pageLayouts.mbdf

1442e8d

add todo comment and explanation

3b7b526

Tejas2805 requested review from marvinchin and nbriannl March 13, 2020 20:50

marvinchin requested changes Mar 14, 2020

View reviewed changes

Update pageLayouts.mbdf

7b1d9a8

Tejas2805 requested a review from marvinchin March 14, 2020 19:54

marvinchin approved these changes Mar 16, 2020

View reviewed changes

marvinchin added this to the v2.12.1 milestone Mar 16, 2020

marvinchin merged commit bdd1f60 into MarkBind:master Mar 16, 2020

Tejas2805 mentioned this pull request Mar 17, 2020

Difference in the way shown to the user #1091

Closed

Tejas2805 added a commit to Tejas2805/markbind that referenced this pull request Mar 21, 2020

Merge branch 'master' of https://github.com/MarkBind/markbind

22b2b74

* 'master' of https://github.com/MarkBind/markbind: Convert code in boxes to code block (MarkBind#1086)

Tejas2805 deleted the convert-to-code-block branch March 21, 2020 09:19

marvinchin pushed a commit that referenced this pull request Apr 10, 2020

Convert code in boxes to code block (#1086)

ab430ce

Let's convert <code> boxes to code blocks to better showcase the feature

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert to code block #1086

Convert to code block #1086

Tejas2805 commented Mar 4, 2020 •

edited

Loading

Tejas2805 commented Mar 7, 2020

Tejas2805 commented Mar 9, 2020

Tejas2805 commented Mar 10, 2020

nbriannl commented Mar 10, 2020 •

edited

Loading

nbriannl left a comment •

edited

Loading

marvinchin left a comment

marvinchin Mar 11, 2020

Tejas2805 Mar 12, 2020

marvinchin Mar 12, 2020

Tejas2805 Mar 12, 2020

marvinchin Mar 12, 2020

Tejas2805 Mar 13, 2020

marvinchin Mar 13, 2020 •

edited

Loading

marvinchin Mar 13, 2020

Tejas2805 Mar 13, 2020

marvinchin left a comment

marvinchin Mar 14, 2020

Tejas2805 Mar 14, 2020

marvinchin left a comment

Convert to code block #1086

Convert to code block #1086

Conversation

Tejas2805 commented Mar 4, 2020 • edited Loading

Tejas2805 commented Mar 7, 2020

Tejas2805 commented Mar 9, 2020

Tejas2805 commented Mar 10, 2020

nbriannl commented Mar 10, 2020 • edited Loading

nbriannl left a comment • edited Loading

Choose a reason for hiding this comment

marvinchin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marvinchin Mar 13, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marvinchin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marvinchin left a comment

Choose a reason for hiding this comment

Tejas2805 commented Mar 4, 2020 •

edited

Loading

nbriannl commented Mar 10, 2020 •

edited

Loading

nbriannl left a comment •

edited

Loading

marvinchin Mar 13, 2020 •

edited

Loading