diff --git a/404.html b/404.html index 3ae838fd..afa22357 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ - MarkBind - Page not found + MarkBind - Page not found @@ -18,50 +18,6 @@ - - - - - - - - diff --git a/about.html b/about.html index caac6df9..3f90245c 100644 --- a/about.html +++ b/about.html @@ -4,7 +4,7 @@ - MarkBind - About Us + MarkBind - About Us @@ -14,7 +14,7 @@

About Us

MarkBind is a project based in National University of Singapore, School of Computing, and is funded by an education grant from NUS Center for Development of Teaching and Learning.

You can email us at markbind at comp.nus.edu.sg

Interested in contributing to MarkBind? Visit the MarkBind project on GitHub.

Contributors โœจ

Mentors:

Dev Team:

Thanks goes to these wonderful people (emoji key):

Tan Wang Leng
Tan Wang Leng
๐Ÿ’ป		 Ang Ze Yu
Ang Ze Yu
๐Ÿ’ป ๐Ÿ“†		 Jason Jiang
Jason Jiang
๐Ÿ’ป		 Chng Zhi Xuan
Chng Zhi Xuan
๐Ÿ’ป		 Aaron Chong
Aaron Chong
๐Ÿ’ป		 Jamos Tay
Jamos Tay
๐Ÿ’ป		 Nicholas Chua
Nicholas Chua
๐Ÿ’ป
Tan Zhen Yong
Tan Zhen Yong
๐Ÿ’ป		 Rachael Sim
Rachael Sim
๐Ÿ’ป		 Ong Wei Xiang
Ong Wei Xiang
๐Ÿ’ป		 Daniel Berzin Chua
Daniel Berzin Chua
๐Ÿ’ป		 Daryl Tan
Daryl Tan
๐Ÿ’ป		 Damith C. Rajapakse
Damith C. Rajapakse
๐Ÿ’ป ๐Ÿง‘โ€๐Ÿซ		 Jonah Tan
Jonah Tan
๐Ÿ’ป ๐Ÿ‘€
nusjzx
nusjzx
๐Ÿ’ป		 Alfred Yip
Alfred Yip
๐Ÿ’ป		 Ryo Armanda
Ryo Armanda
๐Ÿ’ป ๐Ÿ‘€		 Tan Yuanhong
Tan Yuanhong
๐Ÿ’ป		 Si Jie
Si Jie
๐Ÿ’ป		 Yash Chowdhary
Yash Chowdhary
๐Ÿ’ป		 Kenneth Lu
Kenneth Lu
๐Ÿ’ป
Rayson Koh
Rayson Koh
๐Ÿ’ป		 Phang Chun Rong
Phang Chun Rong
๐Ÿ’ป		 nbriannl
nbriannl
๐Ÿ’ป		 Tejas Bhuwania
Tejas Bhuwania
๐Ÿ’ป		 Marvin Chin
Marvin Chin
๐Ÿ’ป		 Aadyaa Maddi
Aadyaa Maddi
๐Ÿ’ป		 Kendrick Ang
Kendrick Ang
๐Ÿ’ป
Daryl Chan
Daryl Chan
๐Ÿ’ป		 Liu YongLiang
Liu YongLiang
๐Ÿ’ป ๐Ÿ“– ๐Ÿ‘€		 Ahmed Bahajjaj
Ahmed Bahajjaj
๐Ÿ’ป		 Hsu Zhong Jun
Hsu Zhong Jun
๐Ÿ’ป		 Kimberly
Kimberly
๐Ÿ’ป		 Joshua Wong
Joshua Wong
๐Ÿ’ป		 Jeremy Tan Jie Rui
Jeremy Tan Jie Rui
๐Ÿ’ป
Anubhav
Anubhav
๐Ÿ’ป		 Boh Cheng Hin
Boh Cheng Hin
๐Ÿ’ป		 Hiroki Nishino
Hiroki Nishino
๐Ÿ’ป		 Junx
Junx
๐Ÿ’ป ๐Ÿ“–		 Li JiaYao
Li JiaYao
๐Ÿ’ป		 Ambrose Liew
Ambrose Liew
๐Ÿ’ป		 Praveen
Praveen
๐Ÿ’ป
Riyadh H. Alzahrani
Riyadh H. Alzahrani
๐Ÿ’ป		 Samuel Fang
Samuel Fang
๐Ÿ’ป		 Thomas Tan
Thomas Tan
๐Ÿ’ป		 Vighnesh Iyer
Vighnesh Iyer
๐Ÿ’ป		 dao ngoc hieu
dao ngoc hieu
๐Ÿ’ป		 Ikko Ashimine
Ikko Ashimine
๐Ÿ“–		 Jovyn Tan
Jovyn Tan
๐Ÿ’ป ๐Ÿ“–
Hannah
Hannah
๐Ÿ’ป ๐Ÿ“–		 NaincyKumariKnoldus
NaincyKumariKnoldus
๐Ÿ“–		 Elroy Goh
Elroy Goh
๐Ÿ’ป		 Elton Goh
Elton Goh
๐Ÿ’ป		 benluiwj
benluiwj
๐Ÿ’ป ๐Ÿ“–		 weiquu
weiquu
๐Ÿ’ป ๐Ÿ“–		 eeliana
eeliana
๐Ÿ“–
Dominic Lim
Dominic Lim
๐Ÿ’ป ๐Ÿ“–		 peter
peter
๐Ÿ’ป		 Calvin Tan
Calvin Tan
๐Ÿ“–		 david
david
๐Ÿ’ป ๐Ÿ“–		 David
David
๐Ÿ“–		 charandeepsinghb
charandeepsinghb
๐Ÿ’ป ๐Ÿ“–		 Jia Yu
Jia Yu
๐Ÿ“–
Lee Hyung Woon / ์ดํ˜•์šด
Lee Hyung Woon / ์ดํ˜•์šด
๐Ÿ’ป		 Chan Yu Cheng
Chan Yu Cheng
๐Ÿ’ป		 Ivad Yves HABIMANA
Ivad Yves HABIMANA
๐Ÿ“–		 Bibhu
Bibhu
๐Ÿ’ป		 WillCWX
WillCWX
๐Ÿ“– ๐Ÿ’ป		 Sven Tang
Sven Tang
๐Ÿ“– ๐Ÿ’ป		 lesterong
lesterong
๐Ÿ’ป
SPWwj
SPWwj
๐Ÿ“– ๐Ÿ’ป		 James
James
๐Ÿ’ป ๐Ÿ“–		 Nisemono
Nisemono
๐Ÿ’ป		 jingting1412
jingting1412
๐Ÿ’ป		 " Xu">
Shuyao "Tim" Xu
๐Ÿ’ป		 Kevin Eyo
Kevin Eyo
๐Ÿ’ป		 Lee Xiong Jie, Isaac
Lee Xiong Jie, Isaac
๐Ÿ’ป
Lam Jiu Fong
Lam Jiu Fong
๐Ÿ’ป		 Wang Yiwen
Wang Yiwen
๐Ÿ“– ๐Ÿ’ป		 Ashleeey1224
Ashleeey1224
๐Ÿ’ป

Past Members:

+

About Us

MarkBind is a project based in National University of Singapore, School of Computing, and is funded by an education grant from NUS Center for Development of Teaching and Learning.

You can email us at markbind at comp.nus.edu.sg

Interested in contributing to MarkBind? Visit the MarkBind project on GitHub.

Contributors โœจ

Mentors:

Dev Team:

Thanks goes to these wonderful people (emoji key):

Tan Wang Leng
Tan Wang Leng
๐Ÿ’ป		 Ang Ze Yu
Ang Ze Yu
๐Ÿ’ป ๐Ÿ“†		 Jason Jiang
Jason Jiang
๐Ÿ’ป		 Chng Zhi Xuan
Chng Zhi Xuan
๐Ÿ’ป		 Aaron Chong
Aaron Chong
๐Ÿ’ป		 Jamos Tay
Jamos Tay
๐Ÿ’ป		 Nicholas Chua
Nicholas Chua
๐Ÿ’ป
Tan Zhen Yong
Tan Zhen Yong
๐Ÿ’ป		 Rachael Sim
Rachael Sim
๐Ÿ’ป		 Ong Wei Xiang
Ong Wei Xiang
๐Ÿ’ป		 Daniel Berzin Chua
Daniel Berzin Chua
๐Ÿ’ป		 Daryl Tan
Daryl Tan
๐Ÿ’ป		 Damith C. Rajapakse
Damith C. Rajapakse
๐Ÿ’ป ๐Ÿง‘โ€๐Ÿซ		 Jonah Tan
Jonah Tan
๐Ÿ’ป ๐Ÿ‘€
nusjzx
nusjzx
๐Ÿ’ป		 Alfred Yip
Alfred Yip
๐Ÿ’ป		 Ryo Armanda
Ryo Armanda
๐Ÿ’ป ๐Ÿ‘€		 Tan Yuanhong
Tan Yuanhong
๐Ÿ’ป		 Si Jie
Si Jie
๐Ÿ’ป		 Yash Chowdhary
Yash Chowdhary
๐Ÿ’ป		 Kenneth Lu
Kenneth Lu
๐Ÿ’ป
Rayson Koh
Rayson Koh
๐Ÿ’ป		 Phang Chun Rong
Phang Chun Rong
๐Ÿ’ป		 nbriannl
nbriannl
๐Ÿ’ป		 Tejas Bhuwania
Tejas Bhuwania
๐Ÿ’ป		 Marvin Chin
Marvin Chin
๐Ÿ’ป		 Aadyaa Maddi
Aadyaa Maddi
๐Ÿ’ป		 Kendrick Ang
Kendrick Ang
๐Ÿ’ป
Daryl Chan
Daryl Chan
๐Ÿ’ป		 Liu YongLiang
Liu YongLiang
๐Ÿ’ป ๐Ÿ“– ๐Ÿ‘€		 Ahmed Bahajjaj
Ahmed Bahajjaj
๐Ÿ’ป		 Hsu Zhong Jun
Hsu Zhong Jun
๐Ÿ’ป		 Kimberly
Kimberly
๐Ÿ’ป		 Joshua Wong
Joshua Wong
๐Ÿ’ป		 Jeremy Tan Jie Rui
Jeremy Tan Jie Rui
๐Ÿ’ป
Anubhav
Anubhav
๐Ÿ’ป		 Boh Cheng Hin
Boh Cheng Hin
๐Ÿ’ป		 Hiroki Nishino
Hiroki Nishino
๐Ÿ’ป		 Junx
Junx
๐Ÿ’ป ๐Ÿ“–		 Li JiaYao
Li JiaYao
๐Ÿ’ป		 Ambrose Liew
Ambrose Liew
๐Ÿ’ป		 Praveen
Praveen
๐Ÿ’ป
Riyadh H. Alzahrani
Riyadh H. Alzahrani
๐Ÿ’ป		 Samuel Fang
Samuel Fang
๐Ÿ’ป		 Thomas Tan
Thomas Tan
๐Ÿ’ป		 Vighnesh Iyer
Vighnesh Iyer
๐Ÿ’ป		 dao ngoc hieu
dao ngoc hieu
๐Ÿ’ป		 Ikko Ashimine
Ikko Ashimine
๐Ÿ“–		 Jovyn Tan
Jovyn Tan
๐Ÿ’ป ๐Ÿ“–
Hannah
Hannah
๐Ÿ’ป ๐Ÿ“–		 NaincyKumariKnoldus
NaincyKumariKnoldus
๐Ÿ“–		 Elroy Goh
Elroy Goh
๐Ÿ’ป		 Elton Goh
Elton Goh
๐Ÿ’ป		 benluiwj
benluiwj
๐Ÿ’ป ๐Ÿ“–		 weiquu
weiquu
๐Ÿ’ป ๐Ÿ“–		 eeliana
eeliana
๐Ÿ“–
Dominic Lim
Dominic Lim
๐Ÿ’ป ๐Ÿ“–		 peter
peter
๐Ÿ’ป		 Calvin Tan
Calvin Tan
๐Ÿ“–		 david
david
๐Ÿ’ป ๐Ÿ“–		 David
David
๐Ÿ“–		 charandeepsinghb
charandeepsinghb
๐Ÿ’ป ๐Ÿ“–		 Jia Yu
Jia Yu
๐Ÿ“–
Lee Hyung Woon / ์ดํ˜•์šด
Lee Hyung Woon / ์ดํ˜•์šด
๐Ÿ’ป		 Chan Yu Cheng
Chan Yu Cheng
๐Ÿ’ป		 Ivad Yves HABIMANA
Ivad Yves HABIMANA
๐Ÿ“–		 Bibhu
Bibhu
๐Ÿ’ป		 WillCWX
WillCWX
๐Ÿ“– ๐Ÿ’ป		 Sven Tang
Sven Tang
๐Ÿ“– ๐Ÿ’ป		 lesterong
lesterong
๐Ÿ’ป
SPWwj
SPWwj
๐Ÿ“– ๐Ÿ’ป		 James
James
๐Ÿ’ป ๐Ÿ“–		 Nisemono
Nisemono
๐Ÿ’ป		 jingting1412
jingting1412
๐Ÿ’ป		 " Xu">
Shuyao "Tim" Xu
๐Ÿ’ป		 Kevin Eyo
Kevin Eyo
๐Ÿ’ป		 Lee Xiong Jie, Isaac
Lee Xiong Jie, Isaac
๐Ÿ’ป
Lam Jiu Fong
Lam Jiu Fong
๐Ÿ’ป		 Wang Yiwen
Wang Yiwen
๐Ÿ“– ๐Ÿ’ป		 Ashleeey1224
Ashleeey1224
๐Ÿ’ป

Past Members:

@@ -23,50 +23,6 @@ - - - - - - - - diff --git a/about.page-vue-render.js b/about.page-vue-render.js index b5d8221b..1d7b6174 100644 --- a/about.page-vue-render.js +++ b/about.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{staticClass:"display-3",attrs:{"id":"about-us"}},[_c('span',[_c('strong',[_v("About Us")])]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#about-us","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"lead"},[_v("MarkBind is a project "),_c('strong',[_v("based in "),_c('a',{attrs:{"href":"http://www.comp.nus.edu.sg/"}},[_v("National University of Singapore, School of Computing")])]),_v(", and is funded by an education grant from "),_c('a',{attrs:{"href":"https://nus.edu.sg/cdtl"}},[_v("NUS Center for Development of Teaching and Learning")]),_v(".")])]),_v(" "),_c('p',[_c('span',{staticClass:"glyphicon glyphicon-send",attrs:{"aria-hidden":"true"}}),_v(" You can "),_c('strong',[_v("email us")]),_v(" at "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind")]),_v(" at "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("comp.nus.edu.sg")])]),_v(" "),_c('p',[_c('span',{staticClass:"glyphicon glyphicon-console",attrs:{"aria-hidden":"true"}}),_v(" Interested in "),_c('strong',[_v("contributing to MarkBind")]),_v("? Visit the "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind"}},[_v("MarkBind project on GitHub")]),_v(".")]),_v(" "),_c('h2',{attrs:{"id":"contributors"}},[_v("Contributors โœจ"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contributors","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Mentors")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('a',{attrs:{"href":"https://www.comp.nus.edu.sg/~damithch/"}},[_c('strong',[_v("Damith C. Rajapakse")])]),_v(": "),_c('em',[_v("Project Mentor")]),_v(" since Aug 2016")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/ang-zeyu"}},[_c('strong',[_v("Ang Ze Yu")])]),_v(": "),_c('em',[_v("Project Mentor")]),_v(" since Jun 2022, "),_c('em',[_v("Team Lead")]),_v(" for Sep 2020 - May 2022")])]),_v(" "),_c('p',[_c('strong',[_v("Dev Team")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('a',{attrs:{"href":"https://www.github.com/jonahtanjz"}},[_c('strong',[_v("Jonah Tan Jun Zi")])]),_v(": "),_c('strong',[_c('em',[_v("Team Lead")])]),_v(" since Jun 2022, "),_c('em',[_v("Member")]),_v(" for Jan 2021 - May 2022")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/ryoarmanda"}},[_c('strong',[_v("Ryo Chandra Putra Aramanda")])]),_v(": "),_c('strong',[_c('em',[_v("Team Lead")])]),_v(" since Jun 2022, "),_c('em',[_v("Member")]),_v(" for Aug 2020 - May 2022")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/raysonkoh"}},[_c('strong',[_v("Koh Rayson")])]),_v(": "),_c('em',[_v("Senior Dev")]),_v(" since Apr 2021, "),_c('em',[_v("Member")]),_v(" since Jan 2021")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/wxwxwxwx9"}},[_c('strong',[_v("Ong Wei Xiang")])]),_v(": "),_c('em',[_v("Senior Dev")]),_v(" since Apr 2021, "),_c('em',[_v("Member")]),_v(" since Aug 2020")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/kaixin-hc"}},[_c('strong',[_v("Hannah Chia Kai Xin")])]),_v(": "),_c('em',[_v("Senior Dev")]),_v(" since Apr 2022, "),_c('em',[_v("Member")]),_v(" since Jan 2022")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/jovyntls"}},[_c('strong',[_v("Jovyn Tan Li Shyan")])]),_v(": "),_c('em',[_v("Senior Dev")]),_v(" since Apr 2022, "),_c('em',[_v("Member")]),_v(" since Jan 2022")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/tlylt"}},[_c('strong',[_v("Liu Yongliang")])]),_v(": "),_c('em',[_v("Senior Dev")]),_v(" since Apr 2022, "),_c('em',[_v("Member")]),_v(" since Aug 2021")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/ong6"}},[_c('strong',[_v("Ong Jun Xiong")])]),_v(": "),_c('em',[_v("Senior Dev")]),_v(" since Apr 2022, "),_c('em',[_v("Member")]),_v(" since Aug 2021")])]),_v(" "),_c('p',[_v("Thanks goes to these wonderful people ("),_c('a',{attrs:{"href":"https://allcontributors.org/docs/en/emoji-key"}},[_v("emoji key")]),_v("):")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',[_c('tbody',[_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://www.yamgent.com/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/3168908?v=4?s=100","width":"100px;","alt":"Tan Wang Leng"}}),_c('br'),_c('sub',[_c('b',[_v("Tan Wang Leng")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=yamgent","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/ang-zeyu"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/3306138?v=4?s=100","width":"100px;","alt":"Ang Ze Yu"}}),_c('br'),_c('sub',[_c('b',[_v("Ang Ze Yu")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=ang-zeyu","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"#projectManagement-ang-zeyu","title":"Project Management"}},[_v("๐Ÿ“†")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/Gisonrg"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/4332224?v=4?s=100","width":"100px;","alt":"Jason Jiang"}}),_c('br'),_c('sub',[_c('b',[_v("Jason Jiang")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=Gisonrg","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/Chng-Zhi-Xuan"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/31084833?v=4?s=100","width":"100px;","alt":"Chng Zhi Xuan"}}),_c('br'),_c('sub',[_c('b',[_v("Chng Zhi Xuan")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=Chng-Zhi-Xuan","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://linkedin.com/in/aaronlah/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/14091939?v=4?s=100","width":"100px;","alt":"Aaron Chong"}}),_c('br'),_c('sub',[_c('b',[_v("Aaron Chong")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=acjh","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/jamos-tay"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/19278089?v=4?s=100","width":"100px;","alt":"Jamos Tay"}}),_c('br'),_c('sub',[_c('b',[_v("Jamos Tay")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=jamos-tay","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://nicholaschuayunzhi.github.io/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/22221132?v=4?s=100","width":"100px;","alt":"Nicholas Chua"}}),_c('br'),_c('sub',[_c('b',[_v("Nicholas Chua")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=nicholaschuayunzhi","title":"Code"}},[_v("๐Ÿ’ป")])])]),_v(" "),_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://www.beyondthesprawl.com/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/1782590?v=4?s=100","width":"100px;","alt":"Tan Zhen Yong"}}),_c('br'),_c('sub',[_c('b',[_v("Tan Zhen Yong")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=Xenonym","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/rachx"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/16644412?v=4?s=100","width":"100px;","alt":"Rachael Sim"}}),_c('br'),_c('sub',[_c('b',[_v("Rachael Sim")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=rachx","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/wxwxwxwx9"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/37920115?v=4?s=100","width":"100px;","alt":"Ong Wei Xiang"}}),_c('br'),_c('sub',[_c('b',[_v("Ong Wei Xiang")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=wxwxwxwx9","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/danielbrzn"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/251231?v=4?s=100","width":"100px;","alt":"Daniel Berzin Chua"}}),_c('br'),_c('sub',[_c('b',[_v("Daniel Berzin Chua")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=danielbrzn","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/openorclose"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/3646725?v=4?s=100","width":"100px;","alt":"Daryl Tan"}}),_c('br'),_c('sub',[_c('b',[_v("Daryl Tan")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=openorclose","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"http://www.comp.nus.edu.sg/~damithch"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/1673303?v=4?s=100","width":"100px;","alt":"Damith C. Rajapakse"}}),_c('br'),_c('sub',[_c('b',[_v("Damith C. Rajapakse")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=damithc","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"#mentoring-damithc","title":"Mentoring"}},[_v("๐Ÿง‘โ€๐Ÿซ")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/jonahtanjz"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/47470981?v=4?s=100","width":"100px;","alt":"Jonah Tan"}}),_c('br'),_c('sub',[_c('b',[_v("Jonah Tan")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=jonahtanjz","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/pulls?q=is%3Apr+reviewed-by%3Ajonahtanjz","title":"Reviewed Pull Requests"}},[_v("๐Ÿ‘€")])])]),_v(" "),_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/nusjzx"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/24241939?v=4?s=100","width":"100px;","alt":"nusjzx"}}),_c('br'),_c('sub',[_c('b',[_v("nusjzx")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=nusjzx","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/alyip98"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/2277141?v=4?s=100","width":"100px;","alt":"Alfred Yip"}}),_c('br'),_c('sub',[_c('b',[_v("Alfred Yip")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=alyip98","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/ryoarmanda"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/24468110?v=4?s=100","width":"100px;","alt":"Ryo Armanda"}}),_c('br'),_c('sub',[_c('b',[_v("Ryo Armanda")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=ryoarmanda","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/pulls?q=is%3Apr+reviewed-by%3Aryoarmanda","title":"Reviewed Pull Requests"}},[_v("๐Ÿ‘€")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/le0tan"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/28982486?v=4?s=100","width":"100px;","alt":"Tan Yuanhong"}}),_c('br'),_c('sub',[_c('b',[_v("Tan Yuanhong")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=le0tan","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://sijie123.com/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/631938?v=4?s=100","width":"100px;","alt":"Si Jie"}}),_c('br'),_c('sub',[_c('b',[_v("Si Jie")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=sijie123","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/yash-chowdhary"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/21968718?v=4?s=100","width":"100px;","alt":"Yash Chowdhary"}}),_c('br'),_c('sub',[_c('b',[_v("Yash Chowdhary")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=yash-chowdhary","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://www.linkedin.com/in/luyangkenneth/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/9073504?v=4?s=100","width":"100px;","alt":"Kenneth Lu"}}),_c('br'),_c('sub',[_c('b',[_v("Kenneth Lu")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=luyangkenneth","title":"Code"}},[_v("๐Ÿ’ป")])])]),_v(" "),_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://raysonkoh.com/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/16506539?v=4?s=100","width":"100px;","alt":"Rayson Koh"}}),_c('br'),_c('sub',[_c('b',[_v("Rayson Koh")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=raysonkoh","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/crphang"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/4986717?v=4?s=100","width":"100px;","alt":"Phang Chun Rong"}}),_c('br'),_c('sub',[_c('b',[_v("Phang Chun Rong")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=crphang","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/nbriannl"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/27397021?v=4?s=100","width":"100px;","alt":"nbriannl"}}),_c('br'),_c('sub',[_c('b',[_v("nbriannl")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=nbriannl","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/Tejas2805"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/35946746?v=4?s=100","width":"100px;","alt":"Tejas Bhuwania"}}),_c('br'),_c('sub',[_c('b',[_v("Tejas Bhuwania")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=Tejas2805","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/marvinchin"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/17447681?v=4?s=100","width":"100px;","alt":"Marvin Chin"}}),_c('br'),_c('sub',[_c('b',[_v("Marvin Chin")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=marvinchin","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/amad-person"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/22164211?v=4?s=100","width":"100px;","alt":"Aadyaa Maddi"}}),_c('br'),_c('sub',[_c('b',[_v("Aadyaa Maddi")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=amad-person","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://kendrickang.github.io/me/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/38814428?v=4?s=100","width":"100px;","alt":"Kendrick Ang"}}),_c('br'),_c('sub',[_c('b',[_v("Kendrick Ang")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=KendrickAng","title":"Code"}},[_v("๐Ÿ’ป")])])]),_v(" "),_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/dvrylc"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/6095637?v=4?s=100","width":"100px;","alt":"Daryl Chan"}}),_c('br'),_c('sub',[_c('b',[_v("Daryl Chan")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=dvrylc","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://tlylt.github.io/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/41845017?v=4?s=100","width":"100px;","alt":"Liu YongLiang"}}),_c('br'),_c('sub',[_c('b',[_v("Liu YongLiang")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=tlylt","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=tlylt","title":"Documentation"}},[_v("๐Ÿ“–")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/pulls?q=is%3Apr+reviewed-by%3Atlylt","title":"Reviewed Pull Requests"}},[_v("๐Ÿ‘€")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://madanalogy.dev/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/42177597?v=4?s=100","width":"100px;","alt":"Ahmed Bahajjaj"}}),_c('br'),_c('sub',[_c('b',[_v("Ahmed Bahajjaj")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=madanalogy","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://www.zhongjun.me/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/27919917?v=4?s=100","width":"100px;","alt":"Hsu Zhong Jun"}}),_c('br'),_c('sub',[_c('b',[_v("Hsu Zhong Jun")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=dcshzj","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/kimberlyohq"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/60393696?v=4?s=100","width":"100px;","alt":"Kimberly"}}),_c('br'),_c('sub',[_c('b',[_v("Kimberly")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=kimberlyohq","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/hcwong"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/28432397?v=4?s=100","width":"100px;","alt":"Joshua Wong"}}),_c('br'),_c('sub',[_c('b',[_v("Joshua Wong")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=hcwong","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://weasyl.com/~parclytaxel"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/54175463?v=4?s=100","width":"100px;","alt":"Jeremy Tan Jie Rui"}}),_c('br'),_c('sub',[_c('b',[_v("Jeremy Tan Jie Rui")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=Parcly-Taxel","title":"Code"}},[_v("๐Ÿ’ป")])])]),_v(" "),_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/anubh-v"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/35621759?v=4?s=100","width":"100px;","alt":"Anubhav"}}),_c('br'),_c('sub',[_c('b',[_v("Anubhav")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=anubh-v","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/bchenghi"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/57175876?v=4?s=100","width":"100px;","alt":"Boh Cheng Hin"}}),_c('br'),_c('sub',[_c('b',[_v("Boh Cheng Hin")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=bchenghi","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://www.tawatawashi.com/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/7100187?v=4?s=100","width":"100px;","alt":"Hiroki Nishino"}}),_c('br'),_c('sub',[_c('b',[_v("Hiroki Nishino")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=tawAsh1","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/ong6"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/19247856?v=4?s=100","width":"100px;","alt":"Junx"}}),_c('br'),_c('sub',[_c('b',[_v("Junx")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=ong6","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=ong6","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://jyl123.github.io/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/24690889?v=4?s=100","width":"100px;","alt":"Li JiaYao"}}),_c('br'),_c('sub',[_c('b',[_v("Li JiaYao")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=JYL123","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://morninglit.github.io/Portfolio2/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/57279935?v=4?s=100","width":"100px;","alt":"Ambrose Liew"}}),_c('br'),_c('sub',[_c('b',[_v("Ambrose Liew")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=MorningLit","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/pr4aveen"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/2839596?v=4?s=100","width":"100px;","alt":"Praveen"}}),_c('br'),_c('sub',[_c('b',[_v("Praveen")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=pr4aveen","title":"Code"}},[_v("๐Ÿ’ป")])])]),_v(" "),_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/riyadh-h"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/69278589?v=4?s=100","width":"100px;","alt":"Riyadh H. Alzahrani"}}),_c('br'),_c('sub',[_c('b',[_v("Riyadh H. Alzahrani")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=riyadh-h","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/samuelfangjw"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/60355570?v=4?s=100","width":"100px;","alt":"Samuel Fang"}}),_c('br'),_c('sub',[_c('b',[_v("Samuel Fang")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=samuelfangjw","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/thomastanck"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/829070?v=4?s=100","width":"100px;","alt":"Thomas Tan"}}),_c('br'),_c('sub',[_c('b',[_v("Thomas Tan")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=thomastanck","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/vig42"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/42461145?v=4?s=100","width":"100px;","alt":"Vighnesh Iyer"}}),_c('br'),_c('sub',[_c('b',[_v("Vighnesh Iyer")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=vig42","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://resumednh.netlify.app/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/53283766?v=4?s=100","width":"100px;","alt":"dao ngoc hieu"}}),_c('br'),_c('sub',[_c('b',[_v("dao ngoc hieu")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=daongochieu2810","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://bandism.net/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/22633385?v=4?s=100","width":"100px;","alt":"Ikko Ashimine"}}),_c('br'),_c('sub',[_c('b',[_v("Ikko Ashimine")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=eltociear","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"http://www.jovyntan.com"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/61113575?v=4?s=100","width":"100px;","alt":"Jovyn Tan"}}),_c('br'),_c('sub',[_c('b',[_v("Jovyn Tan")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=jovyntls","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=jovyntls","title":"Documentation"}},[_v("๐Ÿ“–")])])]),_v(" "),_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/kaixin-hc"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/59471320?v=4?s=100","width":"100px;","alt":"Hannah"}}),_c('br'),_c('sub',[_c('b',[_v("Hannah")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=kaixin-hc","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=kaixin-hc","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/NaincyKumariKnoldus"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/87004609?v=4?s=100","width":"100px;","alt":"NaincyKumariKnoldus"}}),_c('br'),_c('sub',[_c('b',[_v("NaincyKumariKnoldus")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=NaincyKumariKnoldus","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/elroygohjy"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/77185324?v=4?s=100","width":"100px;","alt":"Elroy Goh"}}),_c('br'),_c('sub',[_c('b',[_v("Elroy Goh")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=elroygohjy","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/EltonGohJH"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/75515229?v=4?s=100","width":"100px;","alt":"Elton Goh"}}),_c('br'),_c('sub',[_c('b',[_v("Elton Goh")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=EltonGohJH","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/benluiwj"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/67570985?v=4?s=100","width":"100px;","alt":"benluiwj"}}),_c('br'),_c('sub',[_c('b',[_v("benluiwj")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=benluiwj","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=benluiwj","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/weiquu"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/48304907?v=4?s=100","width":"100px;","alt":"weiquu"}}),_c('br'),_c('sub',[_c('b',[_v("weiquu")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=weiquu","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=weiquu","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/eeliana"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/62977276?v=4?s=100","width":"100px;","alt":"eeliana"}}),_c('br'),_c('sub',[_c('b',[_v("eeliana")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=eeliana","title":"Documentation"}},[_v("๐Ÿ“–")])])]),_v(" "),_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://www.linkedin.com/in/dominiclimkj/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/46486515?v=4?s=100","width":"100px;","alt":"Dominic Lim"}}),_c('br'),_c('sub',[_c('b',[_v("Dominic Lim")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=domlimm","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=domlimm","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/petermonky"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/39848410?v=4?s=100","width":"100px;","alt":"peter"}}),_c('br'),_c('sub',[_c('b',[_v("peter")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=petermonky","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/calvintanwj"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/61271749?v=4?s=100","width":"100px;","alt":"Calvin Tan"}}),_c('br'),_c('sub',[_c('b',[_v("Calvin Tan")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=calvintanwj","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/itsyme"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/71922282?v=4?s=100","width":"100px;","alt":"david"}}),_c('br'),_c('sub',[_c('b',[_v("david")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=itsyme","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=itsyme","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://www.linkedin.com/in/david-limantara/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/67327422?v=4?s=100","width":"100px;","alt":"David"}}),_c('br'),_c('sub',[_c('b',[_v("David")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=xSaints19x","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/charandeepsinghb"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/110289710?v=4?s=100","width":"100px;","alt":"charandeepsinghb"}}),_c('br'),_c('sub',[_c('b',[_v("charandeepsinghb")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=charandeepsinghb","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=charandeepsinghb","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/c00kie123"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/112937454?v=4?s=100","width":"100px;","alt":"Jia Yu"}}),_c('br'),_c('sub',[_c('b',[_v("Jia Yu")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=c00kie123","title":"Documentation"}},[_v("๐Ÿ“–")])])]),_v(" "),_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/lhw-1"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/25716529?v=4?s=100","width":"100px;","alt":"Lee Hyung Woon / ์ดํ˜•์šด"}}),_c('br'),_c('sub',[_c('b',[_v("Lee Hyung Woon / ์ดํ˜•์šด")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=lhw-1","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/yucheng11122017"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/77204346?v=4?s=100","width":"100px;","alt":"Chan Yu Cheng"}}),_c('br'),_c('sub',[_c('b',[_v("Chan Yu Cheng")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=yucheng11122017","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/Yvad60"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/54445417?v=4?s=100","width":"100px;","alt":"Ivad Yves HABIMANA"}}),_c('br'),_c('sub',[_c('b',[_v("Ivad Yves HABIMANA")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=Yvad60","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/bibhu107"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/23478853?v=4?s=100","width":"100px;","alt":"Bibhu"}}),_c('br'),_c('sub',[_c('b',[_v("Bibhu")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=bibhu107","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/WillCWX"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/55905659?v=4?s=100","width":"100px;","alt":"WillCWX"}}),_c('br'),_c('sub',[_c('b',[_v("WillCWX")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=WillCWX","title":"Documentation"}},[_v("๐Ÿ“–")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=WillCWX","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"http://esswhyy.github.io"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/39799639?v=4?s=100","width":"100px;","alt":"Sven Tang"}}),_c('br'),_c('sub',[_c('b',[_v("Sven Tang")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=EssWhyy","title":"Documentation"}},[_v("๐Ÿ“–")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=EssWhyy","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"http://www.lesterong.com"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/84223259?v=4?s=100","width":"100px;","alt":"lesterong"}}),_c('br'),_c('sub',[_c('b',[_v("lesterong")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=lesterong","title":"Code"}},[_v("๐Ÿ’ป")])])]),_v(" "),_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/SPWwj"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/30100720?v=4?s=100","width":"100px;","alt":"SPWwj"}}),_c('br'),_c('sub',[_c('b',[_v("SPWwj")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=SPWwj","title":"Documentation"}},[_v("๐Ÿ“–")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=SPWwj","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://jmestxr.github.io/my-portfolio/"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/87931905?v=4?s=100","width":"100px;","alt":"James"}}),_c('br'),_c('sub',[_c('b',[_v("James")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=jmestxr","title":"Code"}},[_v("๐Ÿ’ป")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=jmestxr","title":"Documentation"}},[_v("๐Ÿ“–")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/zlimez"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/39835365?v=4?s=100","width":"100px;","alt":"Nisemono"}}),_c('br'),_c('sub',[_c('b',[_v("Nisemono")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=zlimez","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/jingting1412"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/105090139?v=4?s=100","width":"100px;","alt":"jingting1412"}}),_c('br'),_c('sub',[_c('b',[_v("jingting1412")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=jingting1412","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"http://tim-siu.github.io"}},[_v("\" Xu\">"),_c('br'),_c('sub',[_c('b',[_v("Shuyao \"Tim\" Xu")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=Tim-Siu","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/KevinEyo1"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/105847348?v=4?s=100","width":"100px;","alt":"Kevin Eyo"}}),_c('br'),_c('sub',[_c('b',[_v("Kevin Eyo")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=KevinEyo1","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/luminousleek"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/68138671?v=4?s=100","width":"100px;","alt":"Lee Xiong Jie, Isaac"}}),_c('br'),_c('sub',[_c('b',[_v("Lee Xiong Jie, Isaac")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=luminousleek","title":"Code"}},[_v("๐Ÿ’ป")])])]),_v(" "),_c('tr',[_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/LamJiuFong"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/122192553?v=4?s=100","width":"100px;","alt":"Lam Jiu Fong"}}),_c('br'),_c('sub',[_c('b',[_v("Lam Jiu Fong")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=LamJiuFong","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/yiwen101"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/121547057?v=4?s=100","width":"100px;","alt":"Wang Yiwen"}}),_c('br'),_c('sub',[_c('b',[_v("Wang Yiwen")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=yiwen101","title":"Documentation"}},[_v("๐Ÿ“–")]),_v(" "),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=yiwen101","title":"Code"}},[_v("๐Ÿ’ป")])]),_v(" "),_c('td',{attrs:{"align":"center","valign":"top","width":"14.28%"}},[_c('a',{attrs:{"href":"https://github.com/Ashleeey1224"}},[_c('img',{attrs:{"src":"https://avatars.githubusercontent.com/u/105656080?v=4?s=100","width":"100px;","alt":"Ashleeey1224"}}),_c('br'),_c('sub',[_c('b',[_v("Ashleeey1224")])])]),_c('br'),_c('a',{attrs:{"href":"https://github.com/MarkBind/markbind/commits?author=Ashleeey1224","title":"Code"}},[_v("๐Ÿ’ป")])])])])])]),_v(" "),_c('hr'),_v(" "),_c('p',[_c('strong',[_c('span',{staticClass:"dimmed"},[_v("Past Members:")])])]),_v(" "),_c('ul',[_c('li',[_c('a',{attrs:{"href":"https://github.com/acjh"}},[_c('strong',[_v("Aaron Chong Jun Hao")])]),_v(": "),_c('em',[_v("Project Mentor")]),_v(" for Jul 2018 - Dec 2020, "),_c('em',[_v("Team Lead")]),_v(" for Aug 2017 - Jun 2018")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/madanalogy"}},[_c('strong',[_v("Ahmed Bahajjaj")])]),_v(": "),_c('em',[_v("Contributor")]),_v(" for Jan-April 2020")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/Chng-Zhi-Xuan"}},[_c('strong',[_v("Chng Zhi Xuan")])]),_v(": "),_c('em',[_v("Member")]),_v(" for May 2018 - Jul 2019")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/nicholaschuayunzhi"}},[_c('strong',[_v("Chua Yun Zhi Nicholas")])]),_v(": "),_c('em',[_v("Member")]),_v(" for Jan 2018 - May 2019")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/danielbrzn"}},[_c('strong',[_v("Daniel Berzin Chua Yuan Siang")])]),_v(": "),_c('em',[_v("Member")]),_v(" for Jan 2018 - Aug 2018")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/dvrylc"}},[_c('strong',[_v("Daryl Chan")])]),_v(": "),_c('em',[_v("Contributor")]),_v(" for Jan-April 2020")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/openorclose"}},[_c('strong',[_v("Daryl Tan")])]),_v(": "),_c('em',[_v("Member")]),_v(" for May 2019 - May 2020")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/jamos-tay"}},[_c('strong',[_v("Jamos Tay")])]),_v(": "),_c('em',[_v("Member")]),_v(" for Aug 2018 - Apr 2019")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/Parcly-Taxel"}},[_c('strong',[_v("Jeremy Tan Jie Rui")])]),_v(": "),_c('em',[_v("Contributor")]),_v(" for Jan-April 2020")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/nusjzx"}},[_c('strong',[_v("Jia Zhixin")])]),_v(": "),_c('em',[_v("Member")]),_v(" for May 2018 - Aug 2018")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/Gisonrg"}},[_c('strong',[_v("Jiang Sheng")])]),_v(": "),_c('em',[_v("Founding Member")]),_v(" and "),_c('em',[_v("Team Lead")]),_v(" for Aug 2016 - Jul 2017")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/hcwong"}},[_c('strong',[_v("Joshua Wong")])]),_v(": "),_c('em',[_v("Contributor")]),_v(" for Jan-April 2020")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/kimberlyohq"}},[_c('strong',[_v("Kimberly Ong Ong Hui Qin")])]),_v(": "),_c('em',[_v("Contributor")]),_v(" for Jun-Jul 2021")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/nbriannl"}},[_c('strong',[_v("Labayna Neil Brian Narido")])]),_v(": "),_c('em',[_v("Member")]),_v(" for Jan - Apr 2020")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/marvinchin"}},[_c('strong',[_v("Marvin Chin Kun Song")])]),_v(": "),_c('em',[_v("Project Lead")]),_v(" for Jan - Aug 2020, "),_c('em',[_v("Member")]),_v(" for Jan 2019 - Aug 2019")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/sijie123"}},[_c('strong',[_v("Lin Si Jie")])]),_v(": "),_c('em',[_v("Member")]),_v(" for Jan - Aug 2019")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/luyangkenneth"}},[_c('strong',[_v("Lu Yang Kenneth")])]),_v(": "),_c('em',[_v("Member")]),_v(" for Jan - Aug 2019")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/amad-person"}},[_c('strong',[_v("Maddi Aadyaa")])]),_v(": "),_c('em',[_v("Member")]),_v(" for Jan - Aug 2019")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/crphang"}},[_c('strong',[_v("Phang Chun Rong")])]),_v(": "),_c('em',[_v("Member")]),_v(" for Aug 2019 - Jun 2020")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/rachx"}},[_c('strong',[_v("Rachael Sim Hwee Ling")])]),_v(": "),_c('em',[_v("Member")]),_v(" for Jan - Dec 2018")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/Xenonym"}},[_c('strong',[_v("Tan Zhen Yong")])]),_v(": "),_c('em',[_v("Member")]),_v(" for Jan - Aug 2019")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/yamgent"}},[_c('strong',[_v("Tan Wang Leng")])]),_v(": "),_c('em',[_v("Team Lead")]),_v(" for Jul 2018 - Apr 2019, "),_c('em',[_v("Member")]),_v(" for May 2018 - Jun 2018")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/Tejas2805"}},[_c('strong',[_v("Tejas Bhuwania")])]),_v(": "),_c('em',[_v("Contributor")]),_v(" for Jan - April 2020")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/le0tan"}},[_c('strong',[_v("Tan Yuanhong")])]),_v(": "),_c('em',[_v("Member")]),_v(": Jan 2020 - Apr 2021")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/yash-chowdhary"}},[_c('strong',[_v("Yash Chowdhary")])]),_v(": "),_c('em',[_v("Member")]),_v(" Jan - Apr 2020")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.github.com/alyip98"}},[_c('strong',[_v("Yip Seng Yeun")])]),_v(": "),_c('em',[_v("Member")]),_v(" May 2019 - Apr 2020")])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/bootcamp/contributeToDocs.html b/devGuide/bootcamp/contributeToDocs.html index 143dd748..6a7d6280 100644 --- a/devGuide/bootcamp/contributeToDocs.html +++ b/devGuide/bootcamp/contributeToDocs.html @@ -4,7 +4,7 @@ - MarkBind - Contribute to Documentation + MarkBind - Contribute to Documentation @@ -33,7 +33,7 @@ Now, you can make a pull request targeting the master branch of the MarkBind repository.

  1. Fill in the pull request template.
  2. Wait for the CI checks to pass.
    1. For first-time contributors, you may need to wait for the MarkBind team to approve your PR before the CI checks can run.
  3. Verify that the PR preview is working.
    1. The PR preview is generated by netlify/markbind-master/deploy-preview.
    2. You can find the link to the PR preview in the checks section of the PR. PR Checks Section
    3. Open the link to the PR preview and ensure that your changes are reflected in the rendered site
  4. Follow up with PR reviews and make changes as requested.

Since this is a hypothetical change, you do not need to raise a PR. You can refer to PR #1924 for an example.

Checkpoint

For actual documentation changes, check that the following are true:

  • The PR template has been filled in
  • The PR preview is working

Summary

In this task, you have learned how to make documentation changes to MarkBind!

While documentation changes are not as exciting as code changes, they are still important. In particular, our documentation is generated by MarkBind itself, utilizing the same features that we are documenting. This means that our documentation is a great place to discover and analyze how MarkBind is used!

Here are some additional tasks for you to try out:

When you are ready, move on to learn how to squash some bugs!

Explore MarkBind as a User

Fix a Bug


+

When you are ready, move on to learn how to squash some bugs!

Explore MarkBind as a User

Fix a Bug


@@ -42,50 +42,6 @@ - - - - - - - - diff --git a/devGuide/bootcamp/contributeToDocs.page-vue-render.js b/devGuide/bootcamp/contributeToDocs.page-vue-render.js index 5e0a2572..bdb3bfca 100644 --- a/devGuide/bootcamp/contributeToDocs.page-vue-render.js +++ b/devGuide/bootcamp/contributeToDocs.page-vue-render.js @@ -65,6 +65,6 @@ with(this){return _c('ul',{staticClass:"contains-task-list"},[_c('li',{staticCla with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Explore MarkBind as a User")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_c('span',[_c('span',[_v("Fix a Bug")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/bootcamp/exploreMarkBind.html b/devGuide/bootcamp/exploreMarkBind.html index 468e24bb..e59e96a8 100644 --- a/devGuide/bootcamp/exploreMarkBind.html +++ b/devGuide/bootcamp/exploreMarkBind.html @@ -4,7 +4,7 @@ - MarkBind - Explore MarkBind as a User + MarkBind - Explore MarkBind as a User @@ -37,26 +37,7 @@ v4.0.2 info: Initialization success. -
Loading...
  1. Ensure that you have added your remote GitHub repository to your local repository with the following command (replace xxx with your GitHub username):
    git remote add origin https://github.com/xxx/mb-dev-xxx.git
-
  2. Commit and push the changes to the main branch with the following commands:
    git add .
 git commit -m "Update content"
 git push origin main
-
  3. Update your GitHub repository setting for deploying to GitHub Pages. -
    1. Navigate to the Settings > Pages section on GitHub for that repository and set the source to Deploy from a branch and the branch to gh-pages and /(root).

Checkpoint

Check that the following are true:

  • The triggered GitHub action runs are successful
  • The site is deployed and available at https://<username>.github.io/mb-dev-xxx/ (after a few seconds to a few minutes)

Congratulations! ๐ŸŽ‰๐ŸŽ‰๐ŸŽ‰ You have deployed your MarkBind site!

Summary

In the first part of this bootcamp, we experimented with MarkBind as a user. We have set up the master branch of MarkBind and created a new MarkBind site. We have also created content with MarkBind components/syntax and deployed our site.

Here are some additional tasks for you to try out:

Take a break now โ˜•๏ธ and we will continue with the second part of the bootcamp!

Onboarding Bootcamp

Contribute to Documentation


+
  1. Navigate to the Settings > Pages section on GitHub for that repository and set the source to Deploy from a branch and the branch to gh-pages and /(root).

Checkpoint

Check that the following are true:

  • The triggered GitHub action runs are successful
  • The site is deployed and available at https://<username>.github.io/mb-dev-xxx/ (after a few seconds to a few minutes)

Congratulations! ๐ŸŽ‰๐ŸŽ‰๐ŸŽ‰ You have deployed your MarkBind site!

Summary

In the first part of this bootcamp, we experimented with MarkBind as a user. We have set up the master branch of MarkBind and created a new MarkBind site. We have also created content with MarkBind components/syntax and deployed our site.

Here are some additional tasks for you to try out:

Take a break now โ˜•๏ธ and we will continue with the second part of the bootcamp!

Onboarding Bootcamp

Contribute to Documentation


@@ -161,50 +104,6 @@ - - - - - - - - diff --git a/devGuide/bootcamp/exploreMarkBind.page-vue-render.js b/devGuide/bootcamp/exploreMarkBind.page-vue-render.js index 8a8eb339..690b2fcc 100644 --- a/devGuide/bootcamp/exploreMarkBind.page-vue-render.js +++ b/devGuide/bootcamp/exploreMarkBind.page-vue-render.js @@ -1,7 +1,7 @@ var pageVueRenderFn = function anonymous( ) { -with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/devdocs/index.html","title":"Home"}},[_c('img',{attrs:{"src":"/devdocs/images/logo-darkbackground.svg","height":"20"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/index.html"}},[_v("HOME")])]),_v(" "),_c('div',{attrs:{"tags":"environment--dg environment--combined"}},[_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"sibling-or-child","href":"/devdocs/devGuide/index.html"}},[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/MarkBind/markbind","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Developer Guide")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_v("Contributing")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Onboarding Bootcamp\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_v("Introduction")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_v("Explore MarkBind as a User")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_v("Contribute to Documentation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_v("Fix a Bug")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_v("Implement a New Feature")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Development \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_v("Setting up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_v("Workflow")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_v("Writing Components")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_v("Writing Plugins")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_v("Migrating to TypeScript")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingNodeJs.html"}},[_v("Migrating Node.js")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Design \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("Project Structure")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_v("Server Side Rendering")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("GitHub Actions\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_v("Overview")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_v("markbind-action")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_v("markbind-reusable-workflows")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_v("Workflow Security")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_v("Project management")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Appendices \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_v("Style guides")])])])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('p',[_v("In this bootcamp, we want to set up the master branch MarkBind so that we can test out any changes we make to the codebase on our local machine.")]),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_v("You can also switch between the master branch MarkBind and check out other branches if you are working on multiple issues. This is also useful when you want to test out a PR submitted by another developer.")])]),_v(" "),_c('p',[_c('panel',{attrs:{"src":"/devdocs/devGuide/development/settingUp._include_.html","type":"info","minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('strong',[_v("Setting up MarkBind")])])]},proxy:true}])})],1),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("After setting up MarkBind, try running from the root directory of your MarkBind repository:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind -v")]),_v(" to check that you have the correct version of MarkBind installed")]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cd docs && markbind serve -d")]),_v(" to check that you can serve the MarkBind documentation site in development mode")])]),_v(" "),_c('p',[_v("If you can browse the MarkBind documentation site that should have automatically been up in your browser at "),_c('a',{attrs:{"href":"http://localhost:8080"}},[_v("http://localhost:8080")]),_v(", you have successfully set up MarkBind!")]),_v(" "),_c('div',{attrs:{"id":"port-info"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf port 8080 is in use, another port will be chosen. Refer to the console output for the exact URL address.\n")])],1),_v(" "),_c('panel',{attrs:{"type":"info","minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_v("Sample Console Output")])]},proxy:true}])},[_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs"}},[_c('span',[_v("$ markbind -v\n")]),_c('span',[_v(" __ __ _ ____ _ _ \n")]),_c('span',[_v(" | \\/ | __ _ _ __ | | __ | __ ) (_) _ __ __| |\n")]),_c('span',[_v(" | |\\/| | / _` | | '__| | |/ / | _ \\ | | | '_ \\ / _` |\n")]),_c('span',[_v(" | | | | | (_| | | | | < | |_) | | | | | | | | (_| |\n")]),_c('span',[_v(" |_| |_| \\__,_| |_| |_|\\_\\ |____/ |_| |_| |_| \\__,_|\n")]),_c('span',[_v("\n")]),_c('span',[_v(" v4.0.2\n")]),_c('span',[_v("Usage: markbind \n")]),_c('span',[_v("\n")]),_c('span',[_v("Options:\n")]),_c('span',[_v(" -V, --version output the version number \n")]),_c('span',[_v(" -h, --help display help for command \n")]),_c('span',[_v("\n")]),_c('span',[_v("Commands:\n")]),_c('span',[_v(" init|i [options] [root] init a markbind website project\n")]),_c('span',[_v(" serve|s [options] [root] build then serve a website from a directory\n")]),_c('span',[_v(" build|b [options] [root] [output] build a website\n")]),_c('span',[_v(" deploy|d [options] [root] deploy the latest build of the site to the repo's Github pages\n")]),_c('span',[_v(" help [command] display help for command\n")]),_c('span',[_v("\n")]),_c('span',[_v("$ cd docs && markbind serve -d\n")]),_c('span',[_v(" __ __ _ ____ _ _\n")]),_c('span',[_v(" | \\/ | __ _ _ __ | | __ | __ ) (_) _ __ __| |\n")]),_c('span',[_v(" | |\\/| | / _` | | '__| | |/ / | _ \\ | | | '_ \\ / _` |\n")]),_c('span',[_v(" | | | | | (_| | | | | < | |_) | | | | | | | | (_| |\n")]),_c('span',[_v(" |_| |_| \\__,_| |_| |_|\\_\\ |____/ |_| |_| |_| \\__,_|\n")]),_c('span',[_v("\n")]),_c('span',[_v(" v4.0.2\n")]),_c('span',[_v("info: Changes detected in MarkBind Vue Source Files:\n")]),_c('span',[_v("Bundle is regenerated by webpack and built pages are re-rendered with the latest bundle.\n")]),_c('span',[_v("info: Website generation started at 4:16:47 pm\n")]),_c('span',[_v("info: Building assets...\n")]),_c('span',[_v("info: Assets built\n")]),_c('span',[_v("info: Generating pages...\n")]),_c('span',[_v("[=======================------------------------------------] 23 / 59 pages [========================-------[======[===[===========================================================] 59 / 59 pages built\n")]),_c('span',[_v("info: Pages built\n")]),_c('span',[_v("webpack built 6d52f45b1910f9f545a2 in 11017ms\n")]),_c('span',[_v("i ๏ฝขwdm๏ฝฃ: Hash: 6d52f45b1910f9f545a2\n")]),_c('span',[_v("Version: webpack 4.46.0\n")]),_c('span',[_v("Time: 11017ms\n")]),_c('span',[_v("Built at: 01/01/2023 4:16:58 pm\n")]),_c('span',[_v(" Asset Size Chunks Chunk Names\n")]),_c('span',[_v(" fonts/KaTeX_AMS-Regular.ttf 62.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_AMS-Regular.woff 32.7 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_AMS-Regular.woff2 27.4 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Caligraphic-Bold.ttf 12.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Caligraphic-Bold.woff 7.54 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Caligraphic-Bold.woff2 6.75 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Caligraphic-Regular.ttf 12.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Caligraphic-Regular.woff 7.48 KiB [emitted]\n")]),_c('span',[_v("fonts/KaTeX_Caligraphic-Regular.woff2 6.75 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Bold.ttf 19.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Bold.woff 13 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Bold.woff2 11.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Regular.ttf 19.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Regular.woff 12.9 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Regular.woff2 11.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Bold.ttf 50.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Bold.woff 29.2 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Bold.woff2 24.7 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-BoldItalic.ttf 32.2 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-BoldItalic.woff 19 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-BoldItalic.woff2 16.4 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Italic.ttf 32.8 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Italic.woff 19.2 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Italic.woff2 16.6 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Regular.ttf 52.3 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Regular.woff 30.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Regular.woff2 25.7 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-BoldItalic.ttf 30.5 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-BoldItalic.woff 18.2 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-BoldItalic.woff2 16 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-Italic.ttf 30.6 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-Italic.woff 18.3 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-Italic.woff2 16.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Bold.ttf 23.9 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Bold.woff 14.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Bold.woff2 11.9 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Italic.ttf 21.8 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Italic.woff 13.8 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Italic.woff2 11.7 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Regular.ttf 19 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Regular.woff 12 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Regular.woff2 10.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Script-Regular.ttf 16.3 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Script-Regular.woff 10.3 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Script-Regular.woff2 9.42 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size1-Regular.ttf 11.9 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size1-Regular.woff 6.34 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size1-Regular.woff2 5.34 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size2-Regular.ttf 11.2 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size2-Regular.woff 6.04 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size2-Regular.woff2 5.09 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size3-Regular.ttf 7.41 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size3-Regular.woff 4.32 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size3-Regular.woff2 3.54 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size4-Regular.ttf 10.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size4-Regular.woff 5.84 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size4-Regular.woff2 4.81 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Typewriter-Regular.ttf 26.9 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Typewriter-Regular.woff 15.7 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Typewriter-Regular.woff2 13.3 KiB [emitted]\n")]),_c('span',[_v(" js/markbind.min.js 1.3 MiB markbind [emitted] markbind\n")]),_c('span',[_v("Entrypoint markbind = js/markbind.min.js\n")]),_c('span',[_v("[0] multi webpack-hot-middleware/client ../packages/core-web/src/index.js 40 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/@babel/runtime/helpers/arrayWithHoles.js] ../node_modules/@babel/runtime/helpers/arrayWithHoles.js \n")]),_c('span',[_v("184 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/@babel/runtime/helpers/defineProperty.js] ../node_modules/@babel/runtime/helpers/defineProperty.js \n")]),_c('span',[_v("367 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/@babel/runtime/helpers/iterableToArrayLimit.js] ../node_modules/@babel/runtime/helpers/iterableToArrayLimit.js 711 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/@babel/runtime/helpers/nonIterableRest.js] ../node_modules/@babel/runtime/helpers/nonIterableRest.js 309 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/@babel/runtime/helpers/slicedToArray.js] ../node_modules/@babel/runtime/helpers/slicedToArray.js 522 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/strip-ansi/index.js] ../node_modules/strip-ansi/index.js 154 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/webpack-hot-middleware/client-overlay.js] ../node_modules/webpack-hot-middleware/client-overlay.js 2.14 KiB {markbind} [built] \n")]),_c('span',[_v("[../../node_modules/webpack-hot-middleware/client.js] ../node_modules/webpack-hot-middleware/client.js 7.69 KiB {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/webpack-hot-middleware/process-update.js] ../node_modules/webpack-hot-middleware/process-update.js 4.36 KiB {markbind} [built] \n")]),_c('span',[_v("[../../node_modules/webpack/buildin/module.js] ../node_modules/webpack/buildin/module.js 497 bytes {markbind} [built]\n")]),_c('span',[_v("[./src/VueCommonAppFactory.js] ../packages/core-web/src/VueCommonAppFactory.js 1.09 KiB {markbind} [built]\n")]),_c('span',[_v("[./src/index.js] ../packages/core-web/src/index.js 8.17 KiB {markbind} [built]\n")]),_c('span',[_v("[./src/scrollTopButton.js] ../packages/core-web/src/scrollTopButton.js 1.49 KiB {markbind} [built]\n")]),_c('span',[_v("[./src/styles/index.css] ../packages/core-web/src/styles/index.css 1.09 KiB {markbind} [built]\n")]),_c('span',[_v(" + 346 hidden modules\n")]),_c('span',[_v("i ๏ฝขwdm๏ฝฃ: Compiled successfully.\n")]),_c('span',[_v("info: Site data built\n")]),_c('span',[_v("info: Website generation complete! Total build time: 11.242s\n")]),_c('span',[_v("info: Serving \"C:\\Users\\User\\Documents\\GitHub\\markbind\\docs\\_site\" at http://127.0.0.1:8080\n")]),_c('span',[_v("info: Press CTRL+C to stop ...\n")])]),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])])],1),_v(" "),_m(7),_v(" "),_c('p',[_v("With MarkBind installed, we can now create a new MarkBind site.")]),_v(" "),_c('p',[_v("We recommend that you set up a new repository for this MarkBind site so that you can push your site to GitHub pages later. This MarkBind site can be used to test out any changes you make to the codebase.")]),_v(" "),_c('p',[_v("As an example, let's create a test site together!")]),_v(" "),_c('box',{attrs:{"type":"tip"}},[_c('p',[_v("You can refer to the example repository "),_c('a',{attrs:{"href":"https://github.com/tlylt/mb-dev-tlylt"}},[_v("here")]),_v(" for the code and "),_c('a',{attrs:{"href":"https://tlylt.github.io/mb-dev-tlylt/"}},[_v("here")]),_v(" for the deployed site if you get stuck.")])]),_v(" "),_c('ol',[_c('li',[_v("Create a new folder called "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("replace 'xxx' with your GitHub username")]},proxy:true}])},[_v("\"mb-dev-xxx\"")]),_v(" at a location outside of the MarkBind source code directory.")],1),_v(" "),_m(8),_v(" "),_m(9)]),_v(" "),_c('p',[_v("You should see the following output:")]),_v(" "),_c('pre',[_m(10),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("After setting up the MarkBind test site, try running the following common operations from the root directory of your test site:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Build the site by running "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind build")])]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Serve the site by running "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve")])]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Serve the site in development mode by running "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve -d")])])]),_v(" "),_c('p',[_v("You now have the test site up and running!")])]),_v(" "),_m(11),_v(" "),_c('p',[_v("MarkBind contains a range of additional syntax on top of Markdown. It also comes with a set of components that can be used to create content.")]),_v(" "),_c('p',[_v("Two essential sections of the user guide to get started with are:")]),_v(" "),_m(12),_v(" "),_c('p',[_c('panel',{attrs:{"src":"/devdocs/userGuide/authoringContents._include_.html","type":"info","minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('strong',[_v("Creating Content")])])]},proxy:true}])})],1),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_m(15),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("With live preview, you should be able to see the changes you have made to the site after saving. Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Serve the site by running "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve -d")])]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Make changes to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("index.md")]),_v(" file and save")]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" See the changes reflected in the live preview, with the correct rendering of the syntax and components")])]),_v(" "),_c('p',[_v("You now have created content with MarkBind!")])]),_v(" "),_m(16),_v(" "),_c('p',[_v("There are a few ways to modify the site's (as well as the page's) structure and configuration. We will cover the following:")]),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_m(19),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Ensure that you are still serving the site with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve -d")]),_v(". Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The rendered page navigation title is changed to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Index Page")])]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The rendered page navigation content now shows "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("H5")]),_v(" headings as well")])]),_v(" "),_c('p',[_v("Screenshot before the changes:")]),_v(" "),_c('p',[_c('pic',{attrs:{"src":"/devdocs/images/bootcamp/page_nav_before.png","alt":"Page navigation title and content before changes"}})],1),_v(" "),_c('p',[_v("Screenshot after the changes:")]),_v(" "),_c('p',[_c('pic',{attrs:{"src":"/devdocs/images/bootcamp/page_nav_after.png","alt":"Page navigation title and content after changes"}})],1)]),_v(" "),_c('p',[_v("Another commonly adjusted structure is the layout of the site (especially, the site's top header and the left-hand-side navigation).")]),_v(" "),_m(20),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Ensure that you are still serving the site with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve -d")]),_v(". Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The rendered page logo in the header is changed to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MarkBind Developer Test Site")])]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The rendered site navigation title is changed to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("My Test Playground")]),_v(" ๐Ÿ’ป")])]),_v(" "),_c('p',[_v("Screenshot after the changes:")]),_v(" "),_c('p',[_c('pic',{attrs:{"src":"/devdocs/images/bootcamp/logo_and_nav.png","alt":"Logo and Nav changes"}})],1)]),_v(" "),_c('p',[_v("Lastly, let's modify the site configuration to change the site title and more.")]),_v(" "),_m(21),_v(" "),_m(22),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Ensure that you are still serving the site with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve -d")]),_v(". Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The page title in the browser tab is changed to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("mb-dev-xxx - Home")])])]),_v(" "),_c('p',[_v("Screenshot after the changes:")]),_v(" "),_c('p',[_c('pic',{attrs:{"src":"/devdocs/images/bootcamp/page_title.png","alt":"Page title changes"}})],1),_v(" "),_c('p',[_v("You now have modified some of the commonly adjusted site structure and configuration!")])]),_v(" "),_m(23),_v(" "),_c('p',[_v("MarkBind sites can be easily deployed with CLI commands or via CI. Let's try deploying our site via GitHub Actions.")]),_v(" "),_m(24),_v(" "),_c('panel',{attrs:{"src":"/devdocs/userGuide/deployingTheSite._include_.html#markbind-action-tip","type":"info","expanded":"","fragment":"markbind-action-tip"},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('strong',[_v("MarkBind Action")])])]},proxy:true}])}),_v(" "),_c('ol',{attrs:{"start":"4"}},[_c('li',[_v("Ensure that you have added your remote GitHub repository to your local repository with the following command (replace "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("xxx")]),_v(" with your GitHub username):"),_c('pre',[_m(25),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])]),_v(" "),_c('li',[_v("Commit and push the changes to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("main")]),_v(" branch with the following commands:"),_c('pre',[_m(26),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])]),_v(" "),_m(27)]),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The triggered GitHub action runs are successful")]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The site is deployed and available at "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://.github.io/mb-dev-xxx/")]),_v(" (after a few seconds to a few minutes)")])]),_v(" "),_c('p',[_v("Congratulations! ๐ŸŽ‰๐ŸŽ‰๐ŸŽ‰ You have deployed your MarkBind site!")])]),_v(" "),_m(28),_v(" "),_c('p',[_v("In the first part of this bootcamp, we experimented with MarkBind as a user. We have set up the master branch of MarkBind and created a new MarkBind site. We have also created content with MarkBind components/syntax and deployed our site.")]),_v(" "),_c('p',[_v("Here are some additional tasks for you to try out:")]),_v(" "),_m(29),_v(" "),_c('p',[_v("Take a break now โ˜•๏ธ and we will continue with the second part of the bootcamp!")]),_v(" "),_m(30),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#explore-markbind-as-a-user"}},[_v("Explore MarkBind as a Userโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#tldr"}},[_v("TLDRโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#setup-the-master-branch-of-markbind"}},[_v("Setup the master branch of MarkBindโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#create-a-markbind-site"}},[_v("Create a MarkBind siteโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#create-content-with-markbind"}},[_v("Create Content with MarkBindโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#modify-site-structure-and-configuration"}},[_v("Modify Site Structure and Configurationโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deploy-your-markbind-site"}},[_v("Deploy your MarkBind siteโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#summary"}},[_v("Summaryโ€Ž")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(31)])} +with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/devdocs/index.html","title":"Home"}},[_c('img',{attrs:{"src":"/devdocs/images/logo-darkbackground.svg","height":"20"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/index.html"}},[_v("HOME")])]),_v(" "),_c('div',{attrs:{"tags":"environment--dg environment--combined"}},[_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"sibling-or-child","href":"/devdocs/devGuide/index.html"}},[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/MarkBind/markbind","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Developer Guide")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_v("Contributing")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Onboarding Bootcamp\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_v("Introduction")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_v("Explore MarkBind as a User")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_v("Contribute to Documentation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_v("Fix a Bug")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_v("Implement a New Feature")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Development \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_v("Setting up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_v("Workflow")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_v("Writing Components")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_v("Writing Plugins")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_v("Migrating to TypeScript")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingNodeJs.html"}},[_v("Migrating Node.js")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Design \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("Project Structure")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_v("Server Side Rendering")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("GitHub Actions\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_v("Overview")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_v("markbind-action")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_v("markbind-reusable-workflows")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_v("Workflow Security")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_v("Project management")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Appendices \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_v("Style guides")])])])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('p',[_v("In this bootcamp, we want to set up the master branch MarkBind so that we can test out any changes we make to the codebase on our local machine.")]),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_v("You can also switch between the master branch MarkBind and check out other branches if you are working on multiple issues. This is also useful when you want to test out a PR submitted by another developer.")])]),_v(" "),_c('p',[_c('panel',{attrs:{"src":"/devdocs/devGuide/development/settingUp._include_.html","type":"info","minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('strong',[_v("Setting up MarkBind")])])]},proxy:true}])})],1),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("After setting up MarkBind, try running from the root directory of your MarkBind repository:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind -v")]),_v(" to check that you have the correct version of MarkBind installed")]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cd docs && markbind serve -d")]),_v(" to check that you can serve the MarkBind documentation site in development mode")])]),_v(" "),_c('p',[_v("If you can browse the MarkBind documentation site that should have automatically been up in your browser at "),_c('a',{attrs:{"href":"http://localhost:8080"}},[_v("http://localhost:8080")]),_v(", you have successfully set up MarkBind!")]),_v(" "),_c('div',{attrs:{"id":"port-info"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf port 8080 is in use, another port will be chosen. Refer to the console output for the exact URL address.\n")])],1),_v(" "),_c('panel',{attrs:{"type":"info","minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_v("Sample Console Output")])]},proxy:true}])},[_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs"}},[_c('span',[_v("$ markbind -v\n")]),_c('span',[_v(" __ __ _ ____ _ _ \n")]),_c('span',[_v(" | \\/ | __ _ _ __ | | __ | __ ) (_) _ __ __| |\n")]),_c('span',[_v(" | |\\/| | / _` | | '__| | |/ / | _ \\ | | | '_ \\ / _` |\n")]),_c('span',[_v(" | | | | | (_| | | | | < | |_) | | | | | | | | (_| |\n")]),_c('span',[_v(" |_| |_| \\__,_| |_| |_|\\_\\ |____/ |_| |_| |_| \\__,_|\n")]),_c('span',[_v("\n")]),_c('span',[_v(" v4.0.2\n")]),_c('span',[_v("Usage: markbind \n")]),_c('span',[_v("\n")]),_c('span',[_v("Options:\n")]),_c('span',[_v(" -V, --version output the version number \n")]),_c('span',[_v(" -h, --help display help for command \n")]),_c('span',[_v("\n")]),_c('span',[_v("Commands:\n")]),_c('span',[_v(" init|i [options] [root] init a markbind website project\n")]),_c('span',[_v(" serve|s [options] [root] build then serve a website from a directory\n")]),_c('span',[_v(" build|b [options] [root] [output] build a website\n")]),_c('span',[_v(" deploy|d [options] [root] deploy the latest build of the site to the repo's Github pages\n")]),_c('span',[_v(" help [command] display help for command\n")]),_c('span',[_v("\n")]),_c('span',[_v("$ cd docs && markbind serve -d\n")]),_c('span',[_v(" __ __ _ ____ _ _\n")]),_c('span',[_v(" | \\/ | __ _ _ __ | | __ | __ ) (_) _ __ __| |\n")]),_c('span',[_v(" | |\\/| | / _` | | '__| | |/ / | _ \\ | | | '_ \\ / _` |\n")]),_c('span',[_v(" | | | | | (_| | | | | < | |_) | | | | | | | | (_| |\n")]),_c('span',[_v(" |_| |_| \\__,_| |_| |_|\\_\\ |____/ |_| |_| |_| \\__,_|\n")]),_c('span',[_v("\n")]),_c('span',[_v(" v4.0.2\n")]),_c('span',[_v("info: Changes detected in MarkBind Vue Source Files:\n")]),_c('span',[_v("Bundle is regenerated by webpack and built pages are re-rendered with the latest bundle.\n")]),_c('span',[_v("info: Website generation started at 4:16:47 pm\n")]),_c('span',[_v("info: Building assets...\n")]),_c('span',[_v("info: Assets built\n")]),_c('span',[_v("info: Generating pages...\n")]),_c('span',[_v("[=======================------------------------------------] 23 / 59 pages [========================-------[======[===[===========================================================] 59 / 59 pages built\n")]),_c('span',[_v("info: Pages built\n")]),_c('span',[_v("webpack built 6d52f45b1910f9f545a2 in 11017ms\n")]),_c('span',[_v("i ๏ฝขwdm๏ฝฃ: Hash: 6d52f45b1910f9f545a2\n")]),_c('span',[_v("Version: webpack 4.46.0\n")]),_c('span',[_v("Time: 11017ms\n")]),_c('span',[_v("Built at: 01/01/2023 4:16:58 pm\n")]),_c('span',[_v(" Asset Size Chunks Chunk Names\n")]),_c('span',[_v(" fonts/KaTeX_AMS-Regular.ttf 62.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_AMS-Regular.woff 32.7 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_AMS-Regular.woff2 27.4 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Caligraphic-Bold.ttf 12.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Caligraphic-Bold.woff 7.54 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Caligraphic-Bold.woff2 6.75 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Caligraphic-Regular.ttf 12.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Caligraphic-Regular.woff 7.48 KiB [emitted]\n")]),_c('span',[_v("fonts/KaTeX_Caligraphic-Regular.woff2 6.75 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Bold.ttf 19.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Bold.woff 13 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Bold.woff2 11.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Regular.ttf 19.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Regular.woff 12.9 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Fraktur-Regular.woff2 11.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Bold.ttf 50.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Bold.woff 29.2 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Bold.woff2 24.7 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-BoldItalic.ttf 32.2 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-BoldItalic.woff 19 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-BoldItalic.woff2 16.4 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Italic.ttf 32.8 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Italic.woff 19.2 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Italic.woff2 16.6 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Regular.ttf 52.3 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Regular.woff 30.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Main-Regular.woff2 25.7 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-BoldItalic.ttf 30.5 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-BoldItalic.woff 18.2 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-BoldItalic.woff2 16 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-Italic.ttf 30.6 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-Italic.woff 18.3 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Math-Italic.woff2 16.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Bold.ttf 23.9 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Bold.woff 14.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Bold.woff2 11.9 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Italic.ttf 21.8 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Italic.woff 13.8 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Italic.woff2 11.7 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Regular.ttf 19 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Regular.woff 12 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_SansSerif-Regular.woff2 10.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Script-Regular.ttf 16.3 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Script-Regular.woff 10.3 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Script-Regular.woff2 9.42 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size1-Regular.ttf 11.9 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size1-Regular.woff 6.34 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size1-Regular.woff2 5.34 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size2-Regular.ttf 11.2 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size2-Regular.woff 6.04 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size2-Regular.woff2 5.09 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size3-Regular.ttf 7.41 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size3-Regular.woff 4.32 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size3-Regular.woff2 3.54 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size4-Regular.ttf 10.1 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size4-Regular.woff 5.84 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Size4-Regular.woff2 4.81 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Typewriter-Regular.ttf 26.9 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Typewriter-Regular.woff 15.7 KiB [emitted]\n")]),_c('span',[_v(" fonts/KaTeX_Typewriter-Regular.woff2 13.3 KiB [emitted]\n")]),_c('span',[_v(" js/markbind.min.js 1.3 MiB markbind [emitted] markbind\n")]),_c('span',[_v("Entrypoint markbind = js/markbind.min.js\n")]),_c('span',[_v("[0] multi webpack-hot-middleware/client ../packages/core-web/src/index.js 40 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/@babel/runtime/helpers/arrayWithHoles.js] ../node_modules/@babel/runtime/helpers/arrayWithHoles.js \n")]),_c('span',[_v("184 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/@babel/runtime/helpers/defineProperty.js] ../node_modules/@babel/runtime/helpers/defineProperty.js \n")]),_c('span',[_v("367 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/@babel/runtime/helpers/iterableToArrayLimit.js] ../node_modules/@babel/runtime/helpers/iterableToArrayLimit.js 711 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/@babel/runtime/helpers/nonIterableRest.js] ../node_modules/@babel/runtime/helpers/nonIterableRest.js 309 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/@babel/runtime/helpers/slicedToArray.js] ../node_modules/@babel/runtime/helpers/slicedToArray.js 522 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/strip-ansi/index.js] ../node_modules/strip-ansi/index.js 154 bytes {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/webpack-hot-middleware/client-overlay.js] ../node_modules/webpack-hot-middleware/client-overlay.js 2.14 KiB {markbind} [built] \n")]),_c('span',[_v("[../../node_modules/webpack-hot-middleware/client.js] ../node_modules/webpack-hot-middleware/client.js 7.69 KiB {markbind} [built]\n")]),_c('span',[_v("[../../node_modules/webpack-hot-middleware/process-update.js] ../node_modules/webpack-hot-middleware/process-update.js 4.36 KiB {markbind} [built] \n")]),_c('span',[_v("[../../node_modules/webpack/buildin/module.js] ../node_modules/webpack/buildin/module.js 497 bytes {markbind} [built]\n")]),_c('span',[_v("[./src/VueCommonAppFactory.js] ../packages/core-web/src/VueCommonAppFactory.js 1.09 KiB {markbind} [built]\n")]),_c('span',[_v("[./src/index.js] ../packages/core-web/src/index.js 8.17 KiB {markbind} [built]\n")]),_c('span',[_v("[./src/scrollTopButton.js] ../packages/core-web/src/scrollTopButton.js 1.49 KiB {markbind} [built]\n")]),_c('span',[_v("[./src/styles/index.css] ../packages/core-web/src/styles/index.css 1.09 KiB {markbind} [built]\n")]),_c('span',[_v(" + 346 hidden modules\n")]),_c('span',[_v("i ๏ฝขwdm๏ฝฃ: Compiled successfully.\n")]),_c('span',[_v("info: Site data built\n")]),_c('span',[_v("info: Website generation complete! Total build time: 11.242s\n")]),_c('span',[_v("info: Serving \"C:\\Users\\User\\Documents\\GitHub\\markbind\\docs\\_site\" at http://127.0.0.1:8080\n")]),_c('span',[_v("info: Press CTRL+C to stop ...\n")])]),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])])],1),_v(" "),_m(7),_v(" "),_c('p',[_v("With MarkBind installed, we can now create a new MarkBind site.")]),_v(" "),_c('p',[_v("We recommend that you set up a new repository for this MarkBind site so that you can push your site to GitHub pages later. This MarkBind site can be used to test out any changes you make to the codebase.")]),_v(" "),_c('p',[_v("As an example, let's create a test site together!")]),_v(" "),_c('box',{attrs:{"type":"tip"}},[_c('p',[_v("You can refer to the example repository "),_c('a',{attrs:{"href":"https://github.com/tlylt/mb-dev-tlylt"}},[_v("here")]),_v(" for the code and "),_c('a',{attrs:{"href":"https://tlylt.github.io/mb-dev-tlylt/"}},[_v("here")]),_v(" for the deployed site if you get stuck.")])]),_v(" "),_c('ol',[_c('li',[_v("Create a new folder called "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("replace 'xxx' with your GitHub username")]},proxy:true}])},[_v("\"mb-dev-xxx\"")]),_v(" at a location outside of the MarkBind source code directory.")],1),_v(" "),_m(8),_v(" "),_m(9)]),_v(" "),_c('p',[_v("You should see the following output:")]),_v(" "),_c('pre',[_m(10),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("After setting up the MarkBind test site, try running the following common operations from the root directory of your test site:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Build the site by running "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind build")])]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Serve the site by running "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve")])]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Serve the site in development mode by running "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve -d")])])]),_v(" "),_c('p',[_v("You now have the test site up and running!")])]),_v(" "),_m(11),_v(" "),_c('p',[_v("MarkBind contains a range of additional syntax on top of Markdown. It also comes with a set of components that can be used to create content.")]),_v(" "),_c('p',[_v("Two essential sections of the user guide to get started with are:")]),_v(" "),_m(12),_v(" "),_c('p',[_c('panel',{attrs:{"src":"/devdocs/userGuide/authoringContents._include_.html","type":"info","minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('strong',[_v("Creating Content")])])]},proxy:true}])})],1),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_m(15),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("With live preview, you should be able to see the changes you have made to the site after saving. Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Serve the site by running "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve -d")])]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Make changes to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("index.md")]),_v(" file and save")]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" See the changes reflected in the live preview, with the correct rendering of the syntax and components")])]),_v(" "),_c('p',[_v("You now have created content with MarkBind!")])]),_v(" "),_m(16),_v(" "),_c('p',[_v("There are a few ways to modify the site's (as well as the page's) structure and configuration. We will cover the following:")]),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_m(19),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Ensure that you are still serving the site with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve -d")]),_v(". Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The rendered page navigation title is changed to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Index Page")])]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The rendered page navigation content now shows "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("H5")]),_v(" headings as well")])]),_v(" "),_c('p',[_v("Screenshot before the changes:")]),_v(" "),_c('p',[_c('pic',{attrs:{"src":"/devdocs/images/bootcamp/page_nav_before.png","alt":"Page navigation title and content before changes"}})],1),_v(" "),_c('p',[_v("Screenshot after the changes:")]),_v(" "),_c('p',[_c('pic',{attrs:{"src":"/devdocs/images/bootcamp/page_nav_after.png","alt":"Page navigation title and content after changes"}})],1)]),_v(" "),_c('p',[_v("Another commonly adjusted structure is the layout of the site (especially, the site's top header and the left-hand-side navigation).")]),_v(" "),_m(20),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Ensure that you are still serving the site with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve -d")]),_v(". Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The rendered page logo in the header is changed to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MarkBind Developer Test Site")])]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The rendered site navigation title is changed to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("My Test Playground")]),_v(" ๐Ÿ’ป")])]),_v(" "),_c('p',[_v("Screenshot after the changes:")]),_v(" "),_c('p',[_c('pic',{attrs:{"src":"/devdocs/images/bootcamp/logo_and_nav.png","alt":"Logo and Nav changes"}})],1)]),_v(" "),_c('p',[_v("Lastly, let's modify the site configuration to change the site title and more.")]),_v(" "),_m(21),_v(" "),_m(22),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Ensure that you are still serving the site with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind serve -d")]),_v(". Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The page title in the browser tab is changed to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("mb-dev-xxx - Home")])])]),_v(" "),_c('p',[_v("Screenshot after the changes:")]),_v(" "),_c('p',[_c('pic',{attrs:{"src":"/devdocs/images/bootcamp/page_title.png","alt":"Page title changes"}})],1),_v(" "),_c('p',[_v("You now have modified some of the commonly adjusted site structure and configuration!")])]),_v(" "),_m(23),_v(" "),_c('p',[_v("MarkBind sites can be easily deployed with CLI commands or via CI. Let's try deploying our site via GitHub Actions.")]),_v(" "),_m(24),_v(" "),_c('panel',{attrs:{"src":"/devdocs/userGuide/deployingTheSite._include_.html#markbind-action-tip","type":"info","expanded":"","fragment":"markbind-action-tip"},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('strong',[_v("MarkBind Action")])])]},proxy:true}])}),_v(" "),_c('ol',{attrs:{"start":"4"}},[_c('li',[_v("Ensure that you have added your remote GitHub repository to your local repository with the following command (replace "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("xxx")]),_v(" with your GitHub username):"),_c('pre',[_m(25),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])]),_v(" "),_c('li',[_v("Commit and push the changes to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("main")]),_v(" branch with the following commands:"),_c('pre',[_m(26),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])]),_v(" "),_m(27)]),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The triggered GitHub action runs are successful")]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The site is deployed and available at "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://.github.io/mb-dev-xxx/")]),_v(" (after a few seconds to a few minutes)")])]),_v(" "),_c('p',[_v("Congratulations! ๐ŸŽ‰๐ŸŽ‰๐ŸŽ‰ You have deployed your MarkBind site!")])]),_v(" "),_m(28),_v(" "),_c('p',[_v("In the first part of this bootcamp, we experimented with MarkBind as a user. We have set up the master branch of MarkBind and created a new MarkBind site. We have also created content with MarkBind components/syntax and deployed our site.")]),_v(" "),_c('p',[_v("Here are some additional tasks for you to try out:")]),_v(" "),_m(29),_v(" "),_c('p',[_v("Take a break now โ˜•๏ธ and we will continue with the second part of the bootcamp!")]),_v(" "),_m(30),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#explore-markbind-as-a-user"}},[_v("Explore MarkBind as a Userโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#tldr"}},[_v("TLDRโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#setup-the-master-branch-of-markbind"}},[_v("Setup the master branch of MarkBindโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#create-a-markbind-site"}},[_v("Create a MarkBind siteโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#create-content-with-markbind"}},[_v("Create Content with MarkBindโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#modify-site-structure-and-configuration"}},[_v("Modify Site Structure and Configurationโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deploy-your-markbind-site"}},[_v("Deploy your MarkBind siteโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#summary"}},[_v("Summaryโ€Ž")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(31)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -98,6 +98,6 @@ with(this){return _c('ul',{staticClass:"contains-task-list"},[_c('li',{staticCla with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Onboarding Bootcamp")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_c('span',[_c('span',[_v("Contribute to Documentation")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/bootcamp/fixABug.html b/devGuide/bootcamp/fixABug.html index 4edddfff..a5bee590 100644 --- a/devGuide/bootcamp/fixABug.html +++ b/devGuide/bootcamp/fixABug.html @@ -4,7 +4,7 @@ - MarkBind - Fix a Bug + MarkBind - Fix a Bug @@ -28,26 +28,7 @@ โ€บโ€บย ย 

Fix a Bug

Fix a Bug

Bug fixes are a great way to improve MarkBind. As the project evolves, bugs are inevitably introduced, reported, and waiting to be fixed.

TLDR

  • Triage
  • Make experimental changes
  • Add tests
  • Update documentation
  • Create PR & Follow up with the reviews

Triage

As bugs can be of varying complexity and involve different parts of the codebase, we will work through a concrete example of a fixed bug to illustrate the process.

Let's suppose we want to fix the bug reported in issue #1954.

The initial steps when a bug is reported are to:

  1. Read and understand the bug report.
    1. This is to ensure that the bug reported needs to be fixed.
  2. Make any necessary clarifications with the reporter.
  3. Reproduce the bug locally.

For practice, let's try to reproduce the bug locally. Run the following command to check out the commit before the bug was fixed:

git checkout 9bb130e1ddb8ac0686d2b7e45bc8b89b79fcb2e4
-

Now, let's use the test site generated in Explore MarkBind as a User to experiment with the bug.

  1. Read the steps to reproduce the bug in the bug report.
  2. Copy the markdown content from the bug report into the contents/topic1.md file in the test site.
  3. Run markbind serve -d to serve the test site.
  4. View the topic1 page in the browser, and observe the browser console output.

Checkpoint

Check that the following are true:

  • The console output contains the error message TypeError: Cannot read property null (reading 'classList')

In some cases, we will need to create a new test site to reproduce the bug. For example, if the bug is related to the MarkBind CLI and the site generation process.

Make Experimental Changes

Now that we have reproduced the bug, we can start tinkering with the code to fix it. This is the part that varies the most from bug to bug, as the bug may be related to different parts of the codebase. With our current setup, we can make changes to the codebase, serve the test site, and observe if the bug is fixed.

When editing files that are written in TypeScript, you will also need to run npm run build:backend in the root directory to compile these files.

For the given example, the required changes can be found here. In gist, changes are made to packages/core/src/Page/index.js and packages/core/src/Page/page.njk to redefine how hasPageNavHeadings is computed and used.

Let's check out the commit that contains the fix:

git checkout 83a3c275732fa4127315b3730f791db5b2f29cb1 
-

Now that we have applied the code logic changes, let's see if the bug is fixed.

  1. Run markbind serve -d to serve the test site again.
  2. View the topic1 page in the browser, and observe the browser console output.

Checkpoint

Check that the following are true:

  • The console output no longer contains the error message TypeError: Cannot read property null (reading 'classList')

Add tests

Now that we know exactly what the bug is and how to fix it, we can add a test to ensure that the bug does not reappear in the future.

We can also aim to be test-driven, where we write the test first, and then write the code to make the test pass.

In this case, we will add a functional test to capture the bug. The required changes can be found here.

The general steps are:

  1. Create a new page in the functional test suite in packages/cli/test/functional/test_site/ if necessary.
    1. In this case, we will add a new page testPageNavTarget.md.
  2. Add content to the page that reproduces the bug.
  3. Update the site.json file to include the new page.
    1. This specifies the page source and gives it a title.

Let's check out the commit that contains the test:

git checkout c9368a35f8e2eb35ca71cabbe7e455fe05771215
-

Now that we have added the test, the test will necessarily fail. This is because the expected output is not yet updated to reflect the changes made to the functional test suite.

Checkpoint

Check that the following are true:

  • Run npm run test in the root directory to run the entire test suite.
  • See that the test fails.

At last, we need to update the expected output via npm run updatetest and commit the changes. You can see the committed changes here. The generated files may not be easy to read, but you should check that the generated content is reasonable (e.g. does not modify unrelated files).

Let's check out the commit that contains the updated expected output:

git checkout b64b632d359d41d9ca662fe15f1de665760becbf
-

Checkpoint

Check that the following are true:

  • Run npm run test in the root directory to run the entire test suite.
  • See that the test passes

Update Documentation

If the bug is related to a feature that is documented, we should update the documentation to reflect the changes. This is especially important if the bug fix changes the behavior of the feature.

In this case, we will not need to update the documentation.

Create PR & Follow up with the Reviews

Now that we have completed our changes, we can create a PR to merge the changes into the master branch.

Similar to Contribute to Documentation, we will need to:

  1. Fill in the pull request template.
  2. Wait for the CI checks to pass.
    1. For first-time contributors, you may need to wait for the MarkBind team to approve your PR before the CI checks can run.
  3. Verify that the PR preview is working. -
    1. The PR preview is generated by netlify/markbind-master/deploy-preview.
    2. You can find the link to the PR preview in the checks section of the PR. PR Checks Section
    3. Open the link to the PR preview and ensure that your changes are reflected in the rendered site
  4. Follow up with PR reviews and make changes as requested.

For changes that involve code logic, some discussion may be required to determine the best way to fix the bug. Hence, it may be helpful to get feedback early either by creating a draft PR or by discussing the approach in the issue thread.

Summary

In this task, you have learned how to deal with a bug report. While the example bug report is simple, the steps are generally the same for more complex bug reports.

Here are some additional tasks for you to try out:

When you are ready, move on to learn how to implement a new feature!

Contribute to Documentation

Implement a New Feature


+
  1. The PR preview is generated by netlify/markbind-master/deploy-preview.
  2. You can find the link to the PR preview in the checks section of the PR. PR Checks Section
  3. Open the link to the PR preview and ensure that your changes are reflected in the rendered site
  • Follow up with PR reviews and make changes as requested.

    • For changes that involve code logic, some discussion may be required to determine the best way to fix the bug. Hence, it may be helpful to get feedback early either by creating a draft PR or by discussing the approach in the issue thread.

    Summary

    In this task, you have learned how to deal with a bug report. While the example bug report is simple, the steps are generally the same for more complex bug reports.

    Here are some additional tasks for you to try out:

    When you are ready, move on to learn how to implement a new feature!

    Contribute to Documentation

    Implement a New Feature


    @@ -186,50 +110,6 @@ - - - - - - - - diff --git a/devGuide/bootcamp/fixABug.page-vue-render.js b/devGuide/bootcamp/fixABug.page-vue-render.js index 515f5041..098b3e94 100644 --- a/devGuide/bootcamp/fixABug.page-vue-render.js +++ b/devGuide/bootcamp/fixABug.page-vue-render.js @@ -1,7 +1,7 @@ var pageVueRenderFn = function anonymous( ) { -with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/devdocs/index.html","title":"Home"}},[_c('img',{attrs:{"src":"/devdocs/images/logo-darkbackground.svg","height":"20"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/index.html"}},[_v("HOME")])]),_v(" "),_c('div',{attrs:{"tags":"environment--dg environment--combined"}},[_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"sibling-or-child","href":"/devdocs/devGuide/index.html"}},[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/MarkBind/markbind","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Developer Guide")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_v("Contributing")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Onboarding Bootcamp\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_v("Introduction")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_v("Explore MarkBind as a User")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_v("Contribute to Documentation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_v("Fix a Bug")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_v("Implement a New Feature")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Development \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_v("Setting up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_v("Workflow")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_v("Writing Components")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_v("Writing Plugins")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_v("Migrating to TypeScript")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingNodeJs.html"}},[_v("Migrating Node.js")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Design \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("Project Structure")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_v("Server Side Rendering")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("GitHub Actions\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_v("Overview")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_v("markbind-action")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_v("markbind-reusable-workflows")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_v("Workflow Security")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_v("Project management")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Appendices \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_v("Style guides")])])])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('p',[_v("As bugs can be of varying complexity and involve different parts of the codebase, we will work through a concrete example of a fixed bug to illustrate the process.")]),_v(" "),_m(6),_v(" "),_c('p',[_v("The initial steps when a bug is reported are to:")]),_v(" "),_m(7),_v(" "),_c('p',[_v("For practice, let's try to reproduce the bug locally. Run the following command to check out the commit before the bug was fixed:")]),_v(" "),_c('pre',[_m(8),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(9),_v(" "),_m(10),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The console output contains the error message "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("TypeError: Cannot read property null (reading 'classList')")])])])]),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_v("In some cases, we will need to create a new test site to reproduce the bug. For example,\nif the bug is related to the MarkBind CLI and the site generation process.")])]),_v(" "),_m(11),_v(" "),_c('p',[_v("Now that we have reproduced the bug, we can start tinkering with the code to fix it. This is the part that varies the most from bug to bug, as the bug may be related to different parts of the codebase. With our current setup, we can make changes to the codebase, serve the test site, and observe if the bug is fixed.")]),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_v("When editing files that are written in TypeScript, you will also need to run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run build:backend")]),_v(" in the root directory to compile these files.")])]),_v(" "),_m(12),_v(" "),_c('p',[_v("Let's check out the commit that contains the fix:")]),_v(" "),_c('pre',[_m(13),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("Now that we have applied the code logic changes, let's see if the bug is fixed.")]),_v(" "),_m(14),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The console output no longer contains the error message "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("TypeError: Cannot read property null (reading 'classList')")])])])]),_v(" "),_m(15),_v(" "),_c('p',[_v("Now that we know exactly what the bug is and how to fix it, we can add a test to ensure that the bug does not reappear in the future.")]),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_v("We can also aim to be test-driven, where we write the test first, and then write the code to make the test pass.")])]),_v(" "),_c('p',[_c('panel',{attrs:{"src":"/devdocs/devGuide/development/workflow._include_.html#workflow-testing","type":"info","minimized":"","fragment":"workflow-testing"},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('strong',[_v("Add Tests")])])]},proxy:true}])})],1),_v(" "),_m(16),_v(" "),_c('p',[_v("The general steps are:")]),_v(" "),_m(17),_v(" "),_c('p',[_v("Let's check out the commit that contains the test:")]),_v(" "),_c('pre',[_m(18),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("Now that we have added the test, the test will necessarily fail. This is because the expected output is not yet updated to reflect the changes made to the functional test suite.")]),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run test")]),_v(" in the root directory to run the entire test suite.")]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" See that the test fails.")])])]),_v(" "),_m(19),_v(" "),_c('p',[_v("Let's check out the commit that contains the updated expected output:")]),_v(" "),_c('pre',[_m(20),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run test")]),_v(" in the root directory to run the entire test suite.")]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" See that the test passes")])])]),_v(" "),_m(21),_v(" "),_c('p',[_v("If the bug is related to a feature that is documented, we should update the documentation to reflect the changes. This is especially important if the bug fix changes the behavior of the feature.")]),_v(" "),_c('p',[_v("In this case, we will not need to update the documentation.")]),_v(" "),_m(22),_v(" "),_c('p',[_v("Now that we have completed our changes, we can create a PR to merge the changes into the master branch.")]),_v(" "),_m(23),_v(" "),_c('div',[_c('ol',[_c('li',[_v("Fill in the pull request template.")]),_v(" "),_m(24),_v(" "),_c('li',[_v("Verify that the PR preview is working.\n"),_c('ol',[_c('li',[_v("The PR preview is generated by netlify/markbind-master/deploy-preview.")]),_v(" "),_c('li',[_v("You can find the link to the PR preview in the checks section of the PR. "),_c('pic',{attrs:{"src":"/devdocs/images/bootcamp/live_preview.png","width":"920","alt":"PR Checks Section"}})],1),_v(" "),_c('li',[_v("Open the link to the PR preview and ensure that your changes are reflected in the rendered site")])])]),_v(" "),_c('li',[_v("Follow up with PR reviews and make changes as requested.")])])]),_v(" "),_c('p',[_v("For changes that involve code logic, some discussion may be required to determine the best way to fix the bug. Hence, it may be helpful to get feedback early either by creating a draft PR or by discussing the approach in the issue thread.")]),_v(" "),_m(25),_v(" "),_c('p',[_v("In this task, you have learned how to deal with a bug report. While the example bug report is simple, the steps are generally the same for more complex bug reports.")]),_v(" "),_c('p',[_v("Here are some additional tasks for you to try out:")]),_v(" "),_m(26),_v(" "),_c('p',[_v("When you are ready, move on to learn how to implement a new feature!")]),_v(" "),_m(27),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#fix-a-bug"}},[_v("Fix a Bugโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#tldr"}},[_v("TLDRโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#triage"}},[_v("Triageโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#make-experimental-changes"}},[_v("Make Experimental Changesโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#add-tests"}},[_v("Add testsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#update-documentation"}},[_v("Update Documentationโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#create-pr-and-amp-follow-up-with-the-reviews"}},[_v("Create PR & Follow up with the Reviewsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#summary"}},[_v("Summaryโ€Ž")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(28)])} +with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/devdocs/index.html","title":"Home"}},[_c('img',{attrs:{"src":"/devdocs/images/logo-darkbackground.svg","height":"20"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/index.html"}},[_v("HOME")])]),_v(" "),_c('div',{attrs:{"tags":"environment--dg environment--combined"}},[_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"sibling-or-child","href":"/devdocs/devGuide/index.html"}},[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/MarkBind/markbind","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Developer Guide")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_v("Contributing")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Onboarding Bootcamp\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_v("Introduction")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_v("Explore MarkBind as a User")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_v("Contribute to Documentation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_v("Fix a Bug")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_v("Implement a New Feature")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Development \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_v("Setting up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_v("Workflow")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_v("Writing Components")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_v("Writing Plugins")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_v("Migrating to TypeScript")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingNodeJs.html"}},[_v("Migrating Node.js")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Design \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("Project Structure")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_v("Server Side Rendering")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("GitHub Actions\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_v("Overview")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_v("markbind-action")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_v("markbind-reusable-workflows")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_v("Workflow Security")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_v("Project management")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Appendices \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_v("Style guides")])])])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('p',[_v("As bugs can be of varying complexity and involve different parts of the codebase, we will work through a concrete example of a fixed bug to illustrate the process.")]),_v(" "),_m(6),_v(" "),_c('p',[_v("The initial steps when a bug is reported are to:")]),_v(" "),_m(7),_v(" "),_c('p',[_v("For practice, let's try to reproduce the bug locally. Run the following command to check out the commit before the bug was fixed:")]),_v(" "),_c('pre',[_m(8),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(9),_v(" "),_m(10),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The console output contains the error message "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("TypeError: Cannot read property null (reading 'classList')")])])])]),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_v("In some cases, we will need to create a new test site to reproduce the bug. For example,\nif the bug is related to the MarkBind CLI and the site generation process.")])]),_v(" "),_m(11),_v(" "),_c('p',[_v("Now that we have reproduced the bug, we can start tinkering with the code to fix it. This is the part that varies the most from bug to bug, as the bug may be related to different parts of the codebase. With our current setup, we can make changes to the codebase, serve the test site, and observe if the bug is fixed.")]),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_v("When editing files that are written in TypeScript, you will also need to run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run build:backend")]),_v(" in the root directory to compile these files.")])]),_v(" "),_m(12),_v(" "),_c('p',[_v("Let's check out the commit that contains the fix:")]),_v(" "),_c('pre',[_m(13),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("Now that we have applied the code logic changes, let's see if the bug is fixed.")]),_v(" "),_m(14),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" The console output no longer contains the error message "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("TypeError: Cannot read property null (reading 'classList')")])])])]),_v(" "),_m(15),_v(" "),_c('p',[_v("Now that we know exactly what the bug is and how to fix it, we can add a test to ensure that the bug does not reappear in the future.")]),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_v("We can also aim to be test-driven, where we write the test first, and then write the code to make the test pass.")])]),_v(" "),_c('p',[_c('panel',{attrs:{"src":"/devdocs/devGuide/development/workflow._include_.html#workflow-testing","type":"info","minimized":"","fragment":"workflow-testing"},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('strong',[_v("Add Tests")])])]},proxy:true}])})],1),_v(" "),_m(16),_v(" "),_c('p',[_v("The general steps are:")]),_v(" "),_m(17),_v(" "),_c('p',[_v("Let's check out the commit that contains the test:")]),_v(" "),_c('pre',[_m(18),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("Now that we have added the test, the test will necessarily fail. This is because the expected output is not yet updated to reflect the changes made to the functional test suite.")]),_v(" "),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run test")]),_v(" in the root directory to run the entire test suite.")]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" See that the test fails.")])])]),_v(" "),_m(19),_v(" "),_c('p',[_v("Let's check out the commit that contains the updated expected output:")]),_v(" "),_c('pre',[_m(20),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('box',{attrs:{"type":"important","light":""}},[_c('p',[_c('strong',[_v("Checkpoint")])]),_v(" "),_c('p',[_v("Check that the following are true:")]),_v(" "),_c('ul',{staticClass:"contains-task-list"},[_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" Run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run test")]),_v(" in the root directory to run the entire test suite.")]),_v(" "),_c('li',{staticClass:"task-list-item enabled"},[_c('input',{staticClass:"task-list-item-checkbox",attrs:{"type":"checkbox"}}),_v(" See that the test passes")])])]),_v(" "),_m(21),_v(" "),_c('p',[_v("If the bug is related to a feature that is documented, we should update the documentation to reflect the changes. This is especially important if the bug fix changes the behavior of the feature.")]),_v(" "),_c('p',[_v("In this case, we will not need to update the documentation.")]),_v(" "),_m(22),_v(" "),_c('p',[_v("Now that we have completed our changes, we can create a PR to merge the changes into the master branch.")]),_v(" "),_m(23),_v(" "),_c('div',[_c('ol',[_c('li',[_v("Fill in the pull request template.")]),_v(" "),_m(24),_v(" "),_c('li',[_v("Verify that the PR preview is working.\n"),_c('ol',[_c('li',[_v("The PR preview is generated by netlify/markbind-master/deploy-preview.")]),_v(" "),_c('li',[_v("You can find the link to the PR preview in the checks section of the PR. "),_c('pic',{attrs:{"src":"/devdocs/images/bootcamp/live_preview.png","width":"920","alt":"PR Checks Section"}})],1),_v(" "),_c('li',[_v("Open the link to the PR preview and ensure that your changes are reflected in the rendered site")])])]),_v(" "),_c('li',[_v("Follow up with PR reviews and make changes as requested.")])])]),_v(" "),_c('p',[_v("For changes that involve code logic, some discussion may be required to determine the best way to fix the bug. Hence, it may be helpful to get feedback early either by creating a draft PR or by discussing the approach in the issue thread.")]),_v(" "),_m(25),_v(" "),_c('p',[_v("In this task, you have learned how to deal with a bug report. While the example bug report is simple, the steps are generally the same for more complex bug reports.")]),_v(" "),_c('p',[_v("Here are some additional tasks for you to try out:")]),_v(" "),_m(26),_v(" "),_c('p',[_v("When you are ready, move on to learn how to implement a new feature!")]),_v(" "),_m(27),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#fix-a-bug"}},[_v("Fix a Bugโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#tldr"}},[_v("TLDRโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#triage"}},[_v("Triageโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#make-experimental-changes"}},[_v("Make Experimental Changesโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#add-tests"}},[_v("Add testsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#update-documentation"}},[_v("Update Documentationโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#create-pr-and-amp-follow-up-with-the-reviews"}},[_v("Create PR & Follow up with the Reviewsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#summary"}},[_v("Summaryโ€Ž")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(28)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -89,6 +89,6 @@ with(this){return _c('ul',{staticClass:"contains-task-list"},[_c('li',{staticCla with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Contribute to Documentation")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_c('span',[_c('span',[_v("Implement a New Feature")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/bootcamp/implementAFeature.html b/devGuide/bootcamp/implementAFeature.html index 687d4c5d..65e9a773 100644 --- a/devGuide/bootcamp/implementAFeature.html +++ b/devGuide/bootcamp/implementAFeature.html @@ -4,7 +4,7 @@ - MarkBind - Implement a New Feature + MarkBind - Implement a New Feature @@ -32,7 +32,7 @@
  • And more!

    • Add Tests & Update Documentation

    (Same as what we mentioned in the previous task)

    By this time, you should have a good idea about how tests and documentation are written. Where possible, unit tests should also be added to ensure that the feature works as expected. Utilizing the new feature in our documentation is also encouraged so that we can get a better idea of how the feature can be used.

    When adding intra-site links, use tags to differentiate between the deployment environment when appropriate, as mentioned in Adding Intra-Site Links to Documentation!

    Create PR & Follow up with the Reviews

    (Same as what we mentioned in the previous task)

    1. Fill in the pull request template.
    2. Wait for the CI checks to pass.
      1. For first-time contributors, you may need to wait for the MarkBind team to approve your PR before the CI checks can run.
    3. Verify that the PR preview is working. -
      1. The PR preview is generated by netlify/markbind-master/deploy-preview.
      2. You can find the link to the PR preview in the checks section of the PR. PR Checks Section
      3. Open the link to the PR preview and ensure that your changes are reflected in the rendered site
    4. Follow up with PR reviews and make changes as requested.

    For features, it is also crucial to get early feedback on implementation details. This is because some considerations may need to be exercised when introducing new user-facing syntax. Another problem is that the implementation may not be the most appropriate or straightforward one, sometimes due to how existing code is structured.

    Issue #1475 is an example where the work in PR #1988 involved changing the implementation midway.

    Summary

    In this part, we have reviewed the steps to implement a new feature. Working on a new feature can be a daunting task, but it is also very rewarding to own a feature from start to finish.

    Here are some additional tasks for you to try out:

    • Look through the mentioned PRs and try to understand how the features were implemented.
    • Look through the issue tracker and see if there are any features that you would like to work on.

    And...that's it!๐Ÿš€๐Ÿš€๐Ÿš€

    You have completed the bootcamp! Take a well-deserved rest and we look forward to your contributions!

    Fix a Bug

    Setting up


    +
    1. The PR preview is generated by netlify/markbind-master/deploy-preview.
    2. You can find the link to the PR preview in the checks section of the PR. PR Checks Section
    3. Open the link to the PR preview and ensure that your changes are reflected in the rendered site
  • Follow up with PR reviews and make changes as requested.

    • For features, it is also crucial to get early feedback on implementation details. This is because some considerations may need to be exercised when introducing new user-facing syntax. Another problem is that the implementation may not be the most appropriate or straightforward one, sometimes due to how existing code is structured.

    Issue #1475 is an example where the work in PR #1988 involved changing the implementation midway.

    Summary

    In this part, we have reviewed the steps to implement a new feature. Working on a new feature can be a daunting task, but it is also very rewarding to own a feature from start to finish.

    Here are some additional tasks for you to try out:

    • Look through the mentioned PRs and try to understand how the features were implemented.
    • Look through the issue tracker and see if there are any features that you would like to work on.

    And...that's it!๐Ÿš€๐Ÿš€๐Ÿš€

    You have completed the bootcamp! Take a well-deserved rest and we look forward to your contributions!

    Fix a Bug

    Setting up


    @@ -41,50 +41,6 @@ - - - - - - - - diff --git a/devGuide/bootcamp/implementAFeature.page-vue-render.js b/devGuide/bootcamp/implementAFeature.page-vue-render.js index b0a5ab31..bbd9d4bd 100644 --- a/devGuide/bootcamp/implementAFeature.page-vue-render.js +++ b/devGuide/bootcamp/implementAFeature.page-vue-render.js @@ -56,6 +56,6 @@ with(this){return _c('ul',{staticClass:"contains-task-list"},[_c('li',{staticCla with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Fix a Bug")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_c('span',[_c('span',[_v("Setting up")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/bootcamp/intro.html b/devGuide/bootcamp/intro.html index 103a91d7..981e35f6 100644 --- a/devGuide/bootcamp/intro.html +++ b/devGuide/bootcamp/intro.html @@ -4,7 +4,7 @@ - MarkBind - Onboarding Bootcamp + MarkBind - Onboarding Bootcamp @@ -27,7 +27,7 @@

    Onboarding Bootcamp

    Onboarding Bootcamp

    New developers are often confused about how to get started in brown-field projects. This onboarding bootcamp is created to ramp up developer familiarity with the MarkBind codebase and get you started with contributing (in a variety of ways) to MarkBind.

    In the following pages, we will go through a series of tasks and you are encouraged to follow along to walk through some of the typical development workflows. When in doubt, you can always refer to the rest of the developer guide for more information.

    Structure

    Each Task will include a "TLDR" section that summarizes the key objectives. This is intended for developers who wish to attempt the task on their own. The rest of the page will include a step-by-step guide and checkpoints -to help you complete the task.

    Summary of Tasks

    1. Explore MarkBind as a user
    2. Contribute to our documentation
    3. Fix a bug
    4. Implement a new feature

    Maintainers' Note

    This onboarding bootcamp is intended for developers who are keen to make more than just one contribution to the project. It is particularly well-suited for onboarding NUS Independent Work Module (CP3108A and CP3108B) and Thematic Systems Project (CS3281 aka Software Engineering in Live Projects) students, but may also be useful to any external developers who wish to dive deeper into the codebase. While we encourage all new developers to go through this process, it is optional and developers are welcome to jump straight into making contributions if they prefer.

    The maintenance of this onboarding bootcamp document does require effort. If you encounter any issues as the materials become outdated or have suggestions, we highly encourage you to submit an issue or make a pull request to update the materials. This will help us keep the onboarding process up-to-date and effective for future developers.

    Contributing

    Explore MarkBind as a User


    +to help you complete the task.

    Summary of Tasks

    1. Explore MarkBind as a user
    2. Contribute to our documentation
    3. Fix a bug
    4. Implement a new feature

    Maintainers' Note

    This onboarding bootcamp is intended for developers who are keen to make more than just one contribution to the project. It is particularly well-suited for onboarding NUS Independent Work Module (CP3108A and CP3108B) and Thematic Systems Project (CS3281 aka Software Engineering in Live Projects) students, but may also be useful to any external developers who wish to dive deeper into the codebase. While we encourage all new developers to go through this process, it is optional and developers are welcome to jump straight into making contributions if they prefer.

    The maintenance of this onboarding bootcamp document does require effort. If you encounter any issues as the materials become outdated or have suggestions, we highly encourage you to submit an issue or make a pull request to update the materials. This will help us keep the onboarding process up-to-date and effective for future developers.

    Contributing

    Explore MarkBind as a User


    @@ -36,50 +36,6 @@ - - - - - - - - diff --git a/devGuide/bootcamp/intro.page-vue-render.js b/devGuide/bootcamp/intro.page-vue-render.js index 2edb494e..ae2a4d0f 100644 --- a/devGuide/bootcamp/intro.page-vue-render.js +++ b/devGuide/bootcamp/intro.page-vue-render.js @@ -35,6 +35,6 @@ with(this){return _c('p',[_v("The maintenance of this onboarding bootcamp docume with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Contributing")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_c('span',[_c('span',[_v("Explore MarkBind as a User")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/design/architecture.html b/devGuide/design/architecture.html index 3ee83cd0..1e9e88b4 100644 --- a/devGuide/design/architecture.html +++ b/devGuide/design/architecture.html @@ -4,7 +4,7 @@ - MarkBind - Architecture + MarkBind - Architecture @@ -28,7 +28,7 @@ โ€บโ€บย ย 

    Architecture

    Architecture

    This page provides an overview of the MarkBind's architecture.

    MarkBind Architecture Diagram

    The above diagram shows the key classes and in MarkBind. You may note the following from these:

    Key classes

    The 3 key classes representing different types of content are as follows:

    1. Page โ€” a page, as specified by the user in their various site configuration glob or src properties. These are directly managed by the Site instance.
    2. Layout โ€” a single layout file, as contained in the _markbind/layouts folder, collectively managed by LayoutManager.

    Note that Layout instances do not generate any output files directly, but rather, they store intermediate processing results to be used in a Page.

    1. External โ€” source files referenced in a Page, Layout or even another External that result in a output file. These output files are loaded dynamically and on-demand in the browser. These instances are managed by a single ExternalManager instance.

    For example, the file referenced by a <panel src="xx.md"> generates a separate xx._include_.html, which is requested and loaded only when the panel is expanded.

    Content processing flow

    Every Page, Layout and External follows the same overall content processing flow, that is:

    Nunjucks Markdown Html

    Note that generation of Externals (e.g. <panel src="...">) do not fall within the content processing flow where they are referenced. These are only flagged for generation, and then processed by ExternalManager after, in another similar content processing flow within an External instance.

    Rationale

    This simple three stage flow provides a simple, predictable content processing flow for the user, and removes several other development concerns:

    1. As the templating language of choice, Nunjucks is always processed first, allowing its templating capabilities to be used to the full extent. -Its syntax is also the most compatible and independent of the other stages.

    2. Secondly, Markdown is rendered before HTML, which produces more HTML. This also allows core Markdown features (e.g. code blocks) and Markdown plugins with eccentric syntaxes to be used without having to patch the HTML parser.

    3. Having processed possibly conflicting Nunjucks and Markdown syntax, HTML is then processed last.

    Project Structure

    Server Side Rendering


    +Its syntax is also the most compatible and independent of the other stages.

  • Secondly, Markdown is rendered before HTML, which produces more HTML. This also allows core Markdown features (e.g. code blocks) and Markdown plugins with eccentric syntaxes to be used without having to patch the HTML parser.

  • Having processed possibly conflicting Nunjucks and Markdown syntax, HTML is then processed last.

    • Project Structure

    Server Side Rendering


    @@ -37,50 +37,6 @@ - - - - - - - - diff --git a/devGuide/design/architecture.page-vue-render.js b/devGuide/design/architecture.page-vue-render.js index 1871868a..5674fae9 100644 --- a/devGuide/design/architecture.page-vue-render.js +++ b/devGuide/design/architecture.page-vue-render.js @@ -41,6 +41,6 @@ with(this){return _c('ol',[_c('li',[_c('p',[_v("As the templating language of ch with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Project Structure")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_c('span',[_c('span',[_v("Server Side Rendering")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/design/projectStructure.html b/devGuide/design/projectStructure.html index 5fe83297..dba4f232 100644 --- a/devGuide/design/projectStructure.html +++ b/devGuide/design/projectStructure.html @@ -4,7 +4,7 @@ - MarkBind - Project Structure + MarkBind - Project Structure @@ -26,7 +26,7 @@

    Project Structure

    Project Structure

    This page gives you an overview of the MarkBind's internal project structure.

    Packages

    The MarkBind project is developed in a (MarkBind/markbind) of 4 packages:

    • The core library, which parses and processes MarkBind's various syntaxes, resides in the packages/core/ directory.

    • The command-line interface (CLI) application, which accepts commands from users and then uses the core library to parse and generate web pages, resides in the packages/cli/ directory.

    • The core web library, which contains a generated web bundle from various setup scripts and the UI components library, resides in packages/core-web/.

    • The UI components library, which MarkBind authors can use to create content with complex and interactive structure, resides in the packages/vue-components/ directory.

      Stack used: Node.js, Vue.js

    MarkBind core library

    The core library mainly houses:

    • Functions and libraries used to parse and process MarkBind into usable output are stored in src. The architecture described in Architecture is contained here. A brief rundown of what it includes:

      • Various key functionalities in processing MarkBind syntax into valid HTML output, stored in html. The other part of the content processing flow is found in variables, which manages site variables and facilitates the Nunjucks calls.

      • Page files generate a single page of the site, and are managed by the Site instance. Site uses the Page model's interface to generate pages, and performs various other utility-like functions related to site generation such as copying of external assets into the output folder.

      • Layout holds the files relating to the layout of the site and are managed by LayoutManager. Similarly, External files, which are separate output files to be loaded dynamically and on-demand, are managed by a ExternalManager instance.

      • Various libraries (contained in lib) and plugins (in plugins) are also stored here. Some external libraries have also been amended to suit MarkBind's purpose โ€“ see patches.

    • MarkBind's templates, used in the markbind init command.

    • Unit Tests (though there are more unit tests and functional tests in the cli library)

    The key external libraries used are:

    • markdown-it, which does the Markdown parsing and rendering. There are also several customized markdown-it plugins used in MarkBind, which are located inside the src/lib/markdown-it/ directory.

      • Several markdown-it plugins are installed to enhance the existing Markdown syntax. They can be found in src/package.json. Some of them are patched in the src/lib/markdown-it/patches/ directory to fit MarkBind's needs.

      • Additionally, there are some markdown-it plugins in the src/lib/markdown-it/plugins/ directory (either forked, modified or written to enhance existing functionalities).

    • htmlparser2, a speedy and forgiving HTML parser which exposes a DOM-like object structure to work on. To comply with the markdown spec, and our custom requirements, src/patches/htmlparser2.js patches various behaviours of this library.

    • cheerio, which is a node.js equivalent of jQuery. Cheerio uses htmlparser2 to parse the HTML as well, hence our patches propagate here.

    • Nunjucks, which is a JavaScript templating engine. Nunjucks is used to support our variable system to help with reusing small bits of code in multiple places. The package is patched and stored in src/patches/nunjucks to make it compatible with other MarkBind syntax processing steps.

    MarkBind CLI

    The CLI application uses and further builds on the interface exposed by the core library's Site model to provide functionalities for the author, such as markbind serve which initiates a live reload workflow.

    The key external libraries used are:

    • commander.js, which is a node.js CLI framework.

    • live-server, which is a simple web server for local development and preview of a MarkBind site. The package is patched and stored in src/lib/live-server with our custom fine tuning.

    MarkBind core-web library

    This package houses the various frontend assets used in the core package.

    Some external assets included are Vue.js, Bootstrap bundles, and FontAwesome bundles.

    Internal bundles are also present, generated from setup scripts, custom stylesheets and the UI components library.

    UI components library

    This package consists of a mix of Bootstrap and proprietary components rewritten in Vue.js based on our needs for educational websites.

    We forked it from the original yuche/vue-strap repo into the MarkBind/vue-strap repo, and then later merged it into the main MarkBind/markbind repo.

    The key dependencies used are:

    • Vue.js (required ^v2.x.x, test with v2.6.14).

    • Bootstrap CSS (required 5.x.x, test with 5.1.3). MarkBind's Vue components doesn't depend on a very precise version of Bootstrap.

    Some custom components and directives are also added for MarkBind's use.

    • MarkBind components newly created or revamped since moving

      • Modal.vue (built on Vue Final Modal)

      • Question.vue

      • QOption.vue

      • Quiz.vue

      • Popover.vue (built on floating-vue's Menu component)

      • Tooltip.vue (built on floating-vue's Tooltip component)

      • Trigger.vue (built on vue-final-modal's $vfm API and Floating Vue's Menus and Tooltips)

    • MarkBind components ported from MarkBind/vue-strap

      • Pic.vue

      • Retriever.vue

      • Searchbar.vue

      • SearchbarPageItem.vue

      • Thumbnail.vue

      • Box.vue

    • Custom directives ported from MarkBind/vue-strap

      • Closeable.js

      • Float.js

    • VueStrap components modified for use in MarkBind

      • Dropdown.vue

      • Navbar.vue

      • NestedPanel.vue

      • MinimalPanel.vue

      • Tab.vue

      • TabGroup.vue

      • Tabset.vue

    Migrating to TypeScript

    Architecture


    +

    Project Structure

    Project Structure

    This page gives you an overview of the MarkBind's internal project structure.

    Packages

    The MarkBind project is developed in a (MarkBind/markbind) of 4 packages:

    • The core library, which parses and processes MarkBind's various syntaxes, resides in the packages/core/ directory.

    • The command-line interface (CLI) application, which accepts commands from users and then uses the core library to parse and generate web pages, resides in the packages/cli/ directory.

    • The core web library, which contains a generated web bundle from various setup scripts and the UI components library, resides in packages/core-web/.

    • The UI components library, which MarkBind authors can use to create content with complex and interactive structure, resides in the packages/vue-components/ directory.

      Stack used: Node.js, Vue.js

    MarkBind core library

    The core library mainly houses:

    • Functions and libraries used to parse and process MarkBind into usable output are stored in src. The architecture described in Architecture is contained here. A brief rundown of what it includes:

      • Various key functionalities in processing MarkBind syntax into valid HTML output, stored in html. The other part of the content processing flow is found in variables, which manages site variables and facilitates the Nunjucks calls.

      • Page files generate a single page of the site, and are managed by the Site instance. Site uses the Page model's interface to generate pages, and performs various other utility-like functions related to site generation such as copying of external assets into the output folder.

      • Layout holds the files relating to the layout of the site and are managed by LayoutManager. Similarly, External files, which are separate output files to be loaded dynamically and on-demand, are managed by a ExternalManager instance.

      • Various libraries (contained in lib) and plugins (in plugins) are also stored here. Some external libraries have also been amended to suit MarkBind's purpose โ€“ see patches.

    • MarkBind's templates, used in the markbind init command.

    • Unit Tests (though there are more unit tests and functional tests in the cli library)

    The key external libraries used are:

    • markdown-it, which does the Markdown parsing and rendering. There are also several customized markdown-it plugins used in MarkBind, which are located inside the src/lib/markdown-it/ directory.

      • Several markdown-it plugins are installed to enhance the existing Markdown syntax. They can be found in src/package.json. Some of them are patched in the src/lib/markdown-it/patches/ directory to fit MarkBind's needs.

      • Additionally, there are some markdown-it plugins in the src/lib/markdown-it/plugins/ directory (either forked, modified or written to enhance existing functionalities).

    • htmlparser2, a speedy and forgiving HTML parser which exposes a DOM-like object structure to work on. To comply with the markdown spec, and our custom requirements, src/patches/htmlparser2.js patches various behaviours of this library.

    • cheerio, which is a node.js equivalent of jQuery. Cheerio uses htmlparser2 to parse the HTML as well, hence our patches propagate here.

    • Nunjucks, which is a JavaScript templating engine. Nunjucks is used to support our variable system to help with reusing small bits of code in multiple places. The package is patched and stored in src/patches/nunjucks to make it compatible with other MarkBind syntax processing steps.

    MarkBind CLI

    The CLI application uses and further builds on the interface exposed by the core library's Site model to provide functionalities for the author, such as markbind serve which initiates a live reload workflow.

    The key external libraries used are:

    • commander.js, which is a node.js CLI framework.

    • live-server, which is a simple web server for local development and preview of a MarkBind site. The package is patched and stored in src/lib/live-server with our custom fine tuning.

    MarkBind core-web library

    This package houses the various frontend assets used in the core package.

    Some external assets included are Vue.js, Bootstrap bundles, and FontAwesome bundles.

    Internal bundles are also present, generated from setup scripts, custom stylesheets and the UI components library.

    UI components library

    This package consists of a mix of Bootstrap and proprietary components rewritten in Vue.js based on our needs for educational websites.

    We forked it from the original yuche/vue-strap repo into the MarkBind/vue-strap repo, and then later merged it into the main MarkBind/markbind repo.

    The key dependencies used are:

    • Vue.js (required ^v2.x.x, test with v2.6.14).

    • Bootstrap CSS (required 5.x.x, test with 5.1.3). MarkBind's Vue components doesn't depend on a very precise version of Bootstrap.

    Some custom components and directives are also added for MarkBind's use.

    • MarkBind components newly created or revamped since moving

      • Modal.vue (built on Vue Final Modal)

      • Question.vue

      • QOption.vue

      • Quiz.vue

      • Popover.vue (built on floating-vue's Menu component)

      • Tooltip.vue (built on floating-vue's Tooltip component)

      • Trigger.vue (built on vue-final-modal's $vfm API and Floating Vue's Menus and Tooltips)

    • MarkBind components ported from MarkBind/vue-strap

      • Pic.vue

      • Retriever.vue

      • Searchbar.vue

      • SearchbarPageItem.vue

      • Thumbnail.vue

      • Box.vue

    • Custom directives ported from MarkBind/vue-strap

      • Closeable.js

      • Float.js

    • VueStrap components modified for use in MarkBind

      • Dropdown.vue

      • Navbar.vue

      • NestedPanel.vue

      • MinimalPanel.vue

      • Tab.vue

      • TabGroup.vue

      • Tabset.vue

    Migrating to TypeScript

    Architecture


    @@ -35,50 +35,6 @@ - - - - - - - - diff --git a/devGuide/design/projectStructure.page-vue-render.js b/devGuide/design/projectStructure.page-vue-render.js index 8b0b4902..bf3c9eac 100644 --- a/devGuide/design/projectStructure.page-vue-render.js +++ b/devGuide/design/projectStructure.page-vue-render.js @@ -71,6 +71,6 @@ with(this){return _c('ul',[_c('li',[_c('p',[_c('strong',[_v("MarkBind components with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Migrating to TypeScript")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_c('span',[_c('span',[_v("Architecture")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/design/serverSideRendering.html b/devGuide/design/serverSideRendering.html index a08cd54d..e6bb3df8 100644 --- a/devGuide/design/serverSideRendering.html +++ b/devGuide/design/serverSideRendering.html @@ -4,7 +4,7 @@ - MarkBind - Server Side Rendering + MarkBind - Server Side Rendering @@ -28,7 +28,7 @@ โ€บโ€บย ย 

    Server Side Rendering

    Server Side Rendering

    MarkBind uses Server-side Rendering (SSR) for its pages.

    To ensure SSR works properly, there are certain rules that developers should adhere to.

    This page will describe SSR in general and elaborate on the caveats that developers should take note of when contributing to MarkBind.

    Pre-requisite Knowledge

    To deal with SSR, it is important to first have a good understanding of two things:

    1. Vue
    2. MarkBind's Packages

    Understanding Vue

    Here is a short list of questions to check your understanding of Vue:

    • What is a Vue instance?
    • What does it mean to compile Vue?
    • What are render functions?
    • Are there any differences between compiling Vue on client-side versus server-side?
    • What is the difference between compiling and rendering?
    Useful Resources to understand Vue better

    If there are any doubts regarding the questions above, here are some good resources to refer to:

    Understanding MarkBind's Packages

    There are four packages in MarkBind's codebase:

    1. cli
    2. core
    3. core-web
    4. vue-components

    You may refer to MarkBind's project structure to get a better understanding of how the packages work together.

    What is Server-side Rendering and Why?

    In MarkBind's context, SSR refers to the generation of proper HTML strings from Vue components on the server (core library) instead of shifting that responsibility to the client-side (browser).

    The main motivation that we had for introducing SSR into MarkBind is to enhance user experience by resolving the unsightly issue of Flash-of-Unstyled-Content (FOUC), which occurs due to our reliance on Client-side Rendering (CSR).

    Client-side Hydration

    SSR and Client-side Hydration are 2 concepts that go hand-in-hand. Essentially, once we produce the static HTML via SSR and send it over to the client-side, Vue on the client-side will execute what is known as Client-side Hydration on the static HTML.

    During the hydration process, Vue essentially compares your SSR HTML markup against the virtual DOM generated by the render function on the client-side. If any difference is found, meaning that the application that we have on the client-side (the virtual DOM tree) differs from the SSR HTML mark-up that we send to the client, Vue will reject the SSR HTML output, bail Client-side Hydration, and execute full CSR.

    This is known as "Hydration Issue" and it is one of the main challenges you will face with SSR in MarkBind.

    Using production build

    In production build, Vue does not perform hydration check. Any errors resulting from hydration will trigger full CSR without warning. MarkBind uses the development build by default when you serve it in development mode (-d option).

    Penalties of Hydration Issue

    When hydration fails, on top of the wasted time and effort in executing SSR, we will also incur the additional time penalty of executing Client-side Hydration (where CSR will follow afterwards).

    Fortunately, even if we face hydration issues and execute full CSR, the FOUC problem will still be resolved nonetheless. The reason for this is because the SSR HTML markup should resemble the CSR HTML markup to a large extent.

    Supposedly, hydration issues typically occurs due to minor differences between client-side rendered virtual DOM tree and the server-rendered content. Of course, this is assuming that we are adhering to the concept of "universal application" as much as possible, which will be explained in the following section.

    Avoiding Hydration Issue

    Conceptually, to prevent hydration issue, what we should always strive to achieve is a "universal application".

    It is not difficult to achieve a "universal application" per-se because we merely have to ensure two things:

    1. the initial state is the same between client-side and server-side.
    2. after compiling and rendering the Vue page application, the SSR HTML mark-up is not modified.

    Beyond achieving a "universal application", note that the HTML specifications should also be adhered to.

    Some common mistakes are as such:

    • Having block-level elements within <p> tag
    • Having unknown HTML elements within our Vue application during compilation/rendering (though this can be easily resolved by adding v-pre to the unknown element, so that Vue will ignore that element during compilation).

    If you are unsure what elements are allowed within other elements, or what constitutes invalid HTML in general, a good resource to reference would be the MDN Web Docs.

    Modern browsers have robust inbuilt mechanisms to auto-correct common causes of hydration. Therefore, to avoid high false positive rate, Markbind has a minimalist rule-based validation against violations. The code for this is located in `core/src/utils/htmlValidationUtils.ts`. -

    Please help extend it when violations that cause hydration on browsers are spotted.

    Note that the list only included the common causes of hydration issue that MarkBind developers have ran into. There may be other causes of hydration issue that are not listed here (although unlikely).

    Architecture

    GitHub Actions: Overview


    +

    Please help extend it when violations that cause hydration on browsers are spotted.

    Note that the list only included the common causes of hydration issue that MarkBind developers have ran into. There may be other causes of hydration issue that are not listed here (although unlikely).

    Architecture

    GitHub Actions: Overview


    @@ -37,50 +37,6 @@ - - - - - - - - diff --git a/devGuide/design/serverSideRendering.page-vue-render.js b/devGuide/design/serverSideRendering.page-vue-render.js index cebd7908..7488863a 100644 --- a/devGuide/design/serverSideRendering.page-vue-render.js +++ b/devGuide/design/serverSideRendering.page-vue-render.js @@ -56,6 +56,6 @@ with(this){return _c('ul',[_c('li',[_v("Having block-level elements within "),_c with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Architecture")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_c('span',[_c('span',[_v("GitHub Actions: Overview")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/devGuide.html b/devGuide/devGuide.html index 4b9bc06a..acbe902c 100644 --- a/devGuide/devGuide.html +++ b/devGuide/devGuide.html @@ -4,7 +4,7 @@ - MarkBind - Contributing + MarkBind - Contributing @@ -26,7 +26,7 @@

    Contributing

    Developer guide

    Contributing

    Thank you for your interest in contributing! We're glad you want to help. We welcome PRs, especially from students.

    First, do take note of our code of conduct (from SE-EDU). Reporting bugs or submitting feature suggestions in our issue tracker can help too.

    Second, ensure you have a basic knowledge of the following:

    • JavaScript (ES6)
    • Node.js
    • HTML & CSS
    • Markdown
    • Command-line environment

    Third, ensure you have spent time with MarkBind and familiar with the content of the user guide. It's important to know the product well before you start contributing code.

    Now, follow these steps to get started on contributing:

    1. Set up the project in your computer (see the Setting up page)
    2. Learn our workflow (see the Workflow page)
    3. (Optional) Go through our onboarding bootcamp (see the Onboarding Bootcamp page)
    4. Submit PRs as per the workflow. If you encounter any problems, post in our issue tracker.
    5. (Optional) Add yourself to the contributors list! (Bug reported? PR merged? If you haven't done so already, add yourself to our list of contributors!)

    We look forward to your PR. Happy coding!

    Onboarding Bootcamp


    +

    Contributing

    Developer guide

    Contributing

    Thank you for your interest in contributing! We're glad you want to help. We welcome PRs, especially from students.

    First, do take note of our code of conduct (from SE-EDU). Reporting bugs or submitting feature suggestions in our issue tracker can help too.

    Second, ensure you have a basic knowledge of the following:

    • JavaScript (ES6)
    • Node.js
    • HTML & CSS
    • Markdown
    • Command-line environment

    Third, ensure you have spent time with MarkBind and familiar with the content of the user guide. It's important to know the product well before you start contributing code.

    Now, follow these steps to get started on contributing:

    1. Set up the project in your computer (see the Setting up page)
    2. Learn our workflow (see the Workflow page)
    3. (Optional) Go through our onboarding bootcamp (see the Onboarding Bootcamp page)
    4. Submit PRs as per the workflow. If you encounter any problems, post in our issue tracker.
    5. (Optional) Add yourself to the contributors list! (Bug reported? PR merged? If you haven't done so already, add yourself to our list of contributors!)

    We look forward to your PR. Happy coding!

    Onboarding Bootcamp


    @@ -35,50 +35,6 @@ - - - - - - - - diff --git a/devGuide/devGuide.page-vue-render.js b/devGuide/devGuide.page-vue-render.js index a8c2eb29..3dbcc5f2 100644 --- a/devGuide/devGuide.page-vue-render.js +++ b/devGuide/devGuide.page-vue-render.js @@ -41,6 +41,6 @@ with(this){return _c('p',[_c('strong',[_v("We look forward to your PR. Happy cod with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_c('span',[_c('span',[_v("Onboarding Bootcamp")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/development/migratingNodeJs.html b/devGuide/development/migratingNodeJs.html index 0f7fc7aa..40335d0f 100644 --- a/devGuide/development/migratingNodeJs.html +++ b/devGuide/development/migratingNodeJs.html @@ -4,7 +4,7 @@ - MarkBind - Migrating Node.js + MarkBind - Migrating Node.js @@ -44,7 +44,7 @@
    • Follow steps in Using CI Platforms but update the config files for the various CI Platforms to use the correct Node.js version. Try deploying and ensure there are no problems with deployment.

      If a different npm version is needed

      Install the correct npm version before running npm commands.
  • Update documentation

    • Writing Plugins

    Project Structure


    +Don't forget to update the version numbers in the example config files in Deploying the Site!

    Writing Plugins

    Project Structure


    @@ -53,50 +53,6 @@ - - - - - - - - diff --git a/devGuide/development/migratingNodeJs.page-vue-render.js b/devGuide/development/migratingNodeJs.page-vue-render.js index d93730bf..2f25e0df 100644 --- a/devGuide/development/migratingNodeJs.page-vue-render.js +++ b/devGuide/development/migratingNodeJs.page-vue-render.js @@ -56,6 +56,6 @@ with(this){return _c('li',[_v("Using the "),_c('code',{pre:true,attrs:{"class":" with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Writing Plugins")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_c('span',[_c('span',[_v("Project Structure")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/development/migratingToTypeScript.html b/devGuide/development/migratingToTypeScript.html index c24034c1..93e06d93 100644 --- a/devGuide/development/migratingToTypeScript.html +++ b/devGuide/development/migratingToTypeScript.html @@ -4,7 +4,7 @@ - MarkBind - Migrating to TypeScript + MarkBind - Migrating to TypeScript @@ -38,7 +38,7 @@ For example: git commit --no-verify -m "Rename core/src/html to TypeScript".

    Step 3: "Adapt" Commit

    1. Start automatic compilation on change/save. More on this at Editing backend features section in the Workflow page.

    2. Change the CommonJS module import/export syntax to TypeScript's equivalent syntax (use ES6 syntax only if possible).

      A common error in newly renamed files comes from the way modules are imported/exported. Those statements can be converted according to the Import/Export Syntax Reference section below. The steps are as follows:

      1. Start by changing the import/export statements into TypeScript equivalent syntax. Be careful with imports as you have to match them with the export syntax that the modules use, be it TypeScript equivalent or ES6.

      2. Check whether it is possible to change the export to use ES6 syntax. As mentioned in the syntax reference, ES6 should not be used if the module only exports a single thing. Change to ES6 syntax only if possible, otherwise keep with TypeScript equivalent syntax.

      3. You might have to adjust how the files are imported by other TypeScript (.ts) files. If you are changing the export to the TypeScript equivalent syntax, then it must be imported the same way as well. The same goes for the ES6 syntax.

    3. Adapt the files fully to TypeScript.

      The errors from TypeScript and typescript-eslint can guide you on what to fix. Only fix what is necessary and be careful with accidentally modifying any code functionality. Avoid using any as best as you can.

      If you happen to encounter type errors related to using names (of constant, properties, members, etc.) from another MarkBind import that is still in JavaScript (.js), you can try to infer simple types in your file first as a "stand-in" of the more robust types when that internal dependency is eventually migrated.

      On the flip side of the above situation, once you have developed a robust type for your own file, adjust how other TypeScript (.ts) files type names referenced from your files as applicable. Some type declarations might need to be made stricter, or can be removed if it's not necessary anymore, and so on. This will ensure that the files will be incrementally stricter.

    4. Make sure everything is in order by running npm run test in the root directory.

      The core package tests can directly run on the .ts files (powered by ts-jest), and the cli package tests uses the compiled files from core. Therefore, passing the cli tests means that it is very likely the compiled files work as expected.

    5. Stage the adapted files and the typings from Step 1 for commit. Verify the changes before committing.

    6. Commit the changes with the message Adapt <file-or-folder> to TypeScript.
      For example, Adapt core/src/html to TypeScript.

    You are now ready to create a pull request for the changes to the repository.

    (Optional) Step 4: Changing the commit

    While refactoring you may encounter scenarios where you might have to amend your code after a commit. There are 2 common scenarios which we will cover.

    Scenario 1: You have 2 commits and want to add on to the second commit.

    Scenario 2: You have more than 2 commits and want to make it into 2 commits.


    Example of Migrated Works

    You can see these pull requests to observe the finished migration works:

    Import/Export Syntax Reference

    Here is the reference on changing the import/export statements from CommonJS syntax into those that TypeScript support: TypeScript equivalent syntax, and ES6 syntax.

    The TypeScript equivalent syntax is designed to compile to the exact same code as CommonJS. You can read more about this syntax in the official documentation.

    The ES6 syntax is the newer JavaScript syntax that TypeScript recommends, but in certain cases it does not compile to the exact same code as CommonJS. We simplify the concepts here for illustration, refer to the StackOverflow post here for more details.

    In the tables below, a "thing" is defined as a JavaScript construct that can be exported, such as constants, functions, classes, etc. In ES6 syntax, a "thing" can also be TypeScript constructs like types, interfaces, enums, etc.

    Exports

    What to Export CommonJS TypeScript equivalent ES6
    One thing only module.exports = x export = x export default x ย ^
    Object of one/more things module.exports = { x, y, z } export = { x, y, z } export { x, y, z }

    ^: For compatibility, do not use export default during migration. It is compiled differently and does not play well with dependants that are still in .js, unless some clunky modifications are made in the .js files (refer to the StackOverflow post previously linked).

    Imports from a module that exports one thing only

    What to Import CommonJS TypeScript equivalent ES6
    Exported thing const x = require(a) import x = require(a) ย ^ import x from a ย ^

    ^: You can only use TypeScript equivalent syntax when the exported module is also in the TypeScript equivalent syntax. The same goes for the ES6 syntax.

    Imports from a module that exports an object of one/more things

    What to Import CommonJS TypeScript equivalent ES6
    Entire object const w = require(a) import w = require(a) import * as w from a
    Selected things const { x } = require(a) N/A ย ^ import { x } from a

    ^: While not equivalent on the compile-level, this can be achieved by importing the entire object then destructuring the object.

    Explanation Notes

    Why do we need to separate "Rename" and "Adapt" commits

    We want to keep the file history intact throughout this migration, meaning that we should still be able to see the change history of the .ts files even from the time when they were still in .js.

    When we rename files, we have to keep the Git similarity index between the old file and the new file above a certain threshold (50%) to keep the history, or else it will be regarded as a different file with its own history.

    Combining the two steps into one - that is, adapting files immediately after renaming - will lower the similarity index, therefore making it possible for the files, especially small ones or those that need a lot of changes when adapting, to hit below the similarity threshold and lose their history.

    The solution to this is to make the rename and adapt commits separate, in order for Git to recognize first that the file has changed into .ts, and so the changes are compared not against the old .js file, but to the renamed .ts file instead.

    Why do we need a rebase and merge commit

    Even if the migration developer has kept the history intact through the separate "Rename" and "Adapt" commits, this is only intact at their working branch. At the end of the day, the totality of the changes in the working branch is compared against the target branch, in which the same consideration would apply.

    If we do the usual squash commit, the changes from the two commits are combined into a new commit and only that commit will be pushed into the target branch. The original two commits are omitted, therefore the history of the working branch that we have tried to keep intact is stripped away. This results in a linear history, as if the changes in the working branch were made -after the latest changes in the target branch.

    Writing Plugins

    Project Structure


    +after the latest changes in the target branch.

    Writing Plugins

    Project Structure


    @@ -47,50 +47,6 @@ - - - - - - - - diff --git a/devGuide/development/migratingToTypeScript.page-vue-render.js b/devGuide/development/migratingToTypeScript.page-vue-render.js index 9dabd45a..17af8e18 100644 --- a/devGuide/development/migratingToTypeScript.page-vue-render.js +++ b/devGuide/development/migratingToTypeScript.page-vue-render.js @@ -131,6 +131,6 @@ with(this){return _c('h3',{attrs:{"id":"why-do-we-need-a-rebase-and-merge-commit with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Writing Plugins")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_c('span',[_c('span',[_v("Project Structure")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/development/settingUp.html b/devGuide/development/settingUp.html index 18db3595..f9ff9459 100644 --- a/devGuide/development/settingUp.html +++ b/devGuide/development/settingUp.html @@ -4,7 +4,7 @@ - MarkBind - Setting up + MarkBind - Setting up @@ -31,7 +31,7 @@ in the root folder of your cloned repo.

  • Congratulations! Now you are ready to start modifying MarkBind code.

    • There are a few Git hooks implemented using the pre-commit tool that runs common tasks like linting, automated tests and compiling typescript files.

    Install the hooks by running python3 ./pre-commit/pre-commit-2.20.0.pyz install in the root folder of your cloned repo.

    If you ever need to uninstall the hooks, simply run uninstall instead of install.

    Common setup questions

    1. Does MarkBind work with all operating systems?

      Yes! We support all operating systems.

    2. How does MarkBind manage dependencies?

      MarkBind uses lerna, a popular multi-package development tool, to manage its dependencies. It is essentially a high level wrapper over node and npm's functionalities.

    3. How do I move back to the released version of MarkBind?

      To go back to the released version of MarkBind, run -npm un -g markbind-cli, followed by npm i -g markbind-cli.

    4. Some of my front-end components are not working as expected when running markbind serve.

      Try running either markbind serve -d or npm run build:web to view frontend changes (especially after pulling a frontend update that someone else may have pushed). You can see more details here.

    Implement a New Feature

    Workflow


    +npm un -g markbind-cli, followed by npm i -g markbind-cli.

  • Some of my front-end components are not working as expected when running markbind serve.

    Try running either markbind serve -d or npm run build:web to view frontend changes (especially after pulling a frontend update that someone else may have pushed). You can see more details here.

    • Implement a New Feature

    Workflow


    @@ -40,50 +40,6 @@ - - - - - - - - diff --git a/devGuide/development/settingUp.page-vue-render.js b/devGuide/development/settingUp.page-vue-render.js index 0bf2eac4..5ed587ce 100644 --- a/devGuide/development/settingUp.page-vue-render.js +++ b/devGuide/development/settingUp.page-vue-render.js @@ -56,6 +56,6 @@ with(this){return _c('ol',[_c('li',[_c('p',[_v("Does MarkBind work with all oper with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Implement a New Feature")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_c('span',[_c('span',[_v("Workflow")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/development/workflow._include_.html b/devGuide/development/workflow._include_.html index ddf95043..1ea54a8b 100644 --- a/devGuide/development/workflow._include_.html +++ b/devGuide/development/workflow._include_.html @@ -58,26 +58,7 @@

    General tips } ] } -

  • Update the tests using npm run updatetest.

    • If creating a new test site instead, the directory name of the new test site should be added to packages/cli/test/functional/testSites.js file.

    We do not commit the generated plantuml images in our test_site to avoid non-related file changes after npm run updatetest. The existing list of images to be ignored is maintained in packages/cli/test/functional/testSites.js and .gitignore. They should be updated accordingly if you are making changes to the plantuml content in our test_site.

    Adding snapshot tests for components

    When making changes to the Vue components in packages/vue-components, you should add new snapshot tests or adapt existing ones as appropriate.

    Once you're done, be sure to run the updatetest script mentioned above!

    Documenting

    In MarkBind, we use tags to differentiate between links in the developer guide referring to the user guide versus links in the user guide referring to the developer guide. Note that intra-site links within either guides need not have tags.

    MarkBind's documentation currently has 3 tags:

    • environment--combined for deploying the User Guide and Developer Guide together
    • environment--ug for deployed User Guide
    • environment--dg for deployed Developer Guide

    To ensure that correct links are created, use tags with the links to selectively filter the correct link to be rendered for the right environment. When both the User Guide and the Developer Guide are deployed together, they have access to the files from each other, allowing the relative link to work. However, when they are deployed individually, this is not the case. Using absolute links creates the same effect as the relative link without having to have access to the files from the other guide.

    Developer Guide

    LINK:

    [Link Title](/userGuide/newPage.html)
-

    REPLACED WITH:

    <a tags="environment--combined" href="/userGuide/newPage.html">Link Title</a>
 <a tags="environment--dg" href="https://markbind.org/userGuide/newPage.html">Link Title</a>
-

    User Guide

    LINK:

    [Link Title](/devGuide/newPage.html)
-

    REPLACED WITH:

    <a tags="environment--combined" href="/devGuide/newPage.html">Link Title</a>
 <a tags="environment--ug" href="https://markbind.org/devdocs/devGuide/newPage.html">Link Title</a>
-

    Linting

    We follow our style guides. Using a linter will help check and fix some of the code style errors in your code. It will save time for both you and your code reviewer. The linting tool we use is ESLint and StyleLint. Here is a gist with an explanation of the ESLint rules chosen in markbind-cli.

    Before making a commit or pull request, you should lint your code by running the following commands from the root of your project:

    • To lint a specific file: eslint path/to/specificfile.js
    • To lint all files: npm run lint

    It is also possible to auto-fix some (not all) style errors, using npm run lintfix.

    ESLint has integrations with popular editors. They offer features such as "fix errors on save", which will make development smoother.

    Git hooks

    We have three git hooks in our project. We use pre-commit to manage our git hooks.
    -The pre-commit scripts are located in ./pre-commit/pre-commit-scripts and the config is found in ./pre-commit-config.yaml.

    To skip running the pre-commit hook or pre-push hook, you can use the --no-verify flag (e.g. git push --no-verify origin fork_branch).

    • post-checkout: When you checkout to another branch, this hook will run clean and build the backend.
    • pre-commit: This hook will run clean, build the backend, and run lintfix on all the files.
    • pre-push: This hook will run clean, build the backend, and run all the test cases.

    Dependency management

    As mentioned in the setting up page, MarkBind uses lerna to manage the dependencies of its various packages.

    To add a dependency

    Add your dependency into the appropriate package.json file inside packages/*. If this is a development dependency to be used across all packages (e.g. ESLint), add it the the root package.json.

    Then, simply rerun the npm run setup command to update the package-lock.json files.

    To delete a dependency

    The safest way is to first remove the particular dependency entry from the package.json file of the respective directory. Then, run npm run setup in the root directory to clean up the local dependencies and update the package-lock.json file.

    To update a dependency

    First, follow the instruction to delete the dependency. Then, follow the instruction to add the latest dependency back. Also, when updating dependencies, ensure that it is updated in all packages using that dependency.

    Dependency updates are not trivial, and can be the source of subtle bugs. You should always check the respective dependency changelogs before doing so!

    Points for consideration

    There are a few ways to incorporate external packages into MarkBind, each with its pros and cons. The following table shows some of the common trade-offs:

    Approach Pros Cons
    Installing
    • Ease of upgrade
    • Traceable in package.json
    • May not satisfy custom behavior
    • Become vulnerable if the source repo is no longer actively maintained
    Forking
    • Relatively easy to upgrade
    • Leverage upstream testing procedures
    • Benefit others who share the same use cases
    • May become out-of-sync with the latest version
    • Difficult to maintain it externally in the long run
    Patching
    • Quick - no need to maintain / publish more npm packages or setup release procedures etc
    • Ensure the changes propagate to other dependencies
    • Enjoy the benefits of monorepo
    • Difficult to upgrade

    As the choice is highly dependent on context and details of the implementation, below are some additional questions to ask before proceeding:

    • Is the package actively maintained?
    • How big is the package?
    • How invasive are the proposed changes?
    • Are there existing APIs/plugin system from the package (to modify default behaviors)?

    Find out more about the key external libraries used in MarkBind from the project structure section. Also, the rationales behind most existing patches are documented in their respective files, read them (and their respective PRs/issues) for more context!

    Updating PlantUML

    PlantUML is a third-party library used by MarkBind to create UML diagrams. MarkBind runs the PlantUML JAR file found in packages/core/src/plugins/default when building the site to generate the diagrams.

    To update PlantUML to a newer version:

    1. Download the JAR file from PlantUML's website.
    2. Rename the file to plantuml.jar (if required), and replace the existing JAR file located in packages/core/src/plugins/default.
    3. Check the HTML pages that contain PlantUML diagrams, i.e. /userGuide/components/imagesAndDiagrams.html.

    Updating Bootstrap and Bootswatch

    As Bootswatch is built on Bootstrap, ensure that the versions of both are in sync to avoid unexpected differences in styling behavior between default and other themes. Both are currently using version 5.1.3.

    Setting up

    Writing Components


    +The pre-commit scripts are located in ./pre-commit/pre-commit-scripts and the config is found in ./pre-commit-config.yaml.

    To skip running the pre-commit hook or pre-push hook, you can use the --no-verify flag (e.g. git push --no-verify origin fork_branch).

    • post-checkout: When you checkout to another branch, this hook will run clean and build the backend.
    • pre-commit: This hook will run clean, build the backend, and run lintfix on all the files.
    • pre-push: This hook will run clean, build the backend, and run all the test cases.

    Dependency management

    As mentioned in the setting up page, MarkBind uses lerna to manage the dependencies of its various packages.

    To add a dependency

    Add your dependency into the appropriate package.json file inside packages/*. If this is a development dependency to be used across all packages (e.g. ESLint), add it the the root package.json.

    Then, simply rerun the npm run setup command to update the package-lock.json files.

    To delete a dependency

    The safest way is to first remove the particular dependency entry from the package.json file of the respective directory. Then, run npm run setup in the root directory to clean up the local dependencies and update the package-lock.json file.

    To update a dependency

    First, follow the instruction to delete the dependency. Then, follow the instruction to add the latest dependency back. Also, when updating dependencies, ensure that it is updated in all packages using that dependency.

    Dependency updates are not trivial, and can be the source of subtle bugs. You should always check the respective dependency changelogs before doing so!

    Points for consideration

    There are a few ways to incorporate external packages into MarkBind, each with its pros and cons. The following table shows some of the common trade-offs:

    Approach Pros Cons
    Installing
    • Ease of upgrade
    • Traceable in package.json
    • May not satisfy custom behavior
    • Become vulnerable if the source repo is no longer actively maintained
    Forking
    • Relatively easy to upgrade
    • Leverage upstream testing procedures
    • Benefit others who share the same use cases
    • May become out-of-sync with the latest version
    • Difficult to maintain it externally in the long run
    Patching
    • Quick - no need to maintain / publish more npm packages or setup release procedures etc
    • Ensure the changes propagate to other dependencies
    • Enjoy the benefits of monorepo
    • Difficult to upgrade

    As the choice is highly dependent on context and details of the implementation, below are some additional questions to ask before proceeding:

    • Is the package actively maintained?
    • How big is the package?
    • How invasive are the proposed changes?
    • Are there existing APIs/plugin system from the package (to modify default behaviors)?

    Find out more about the key external libraries used in MarkBind from the project structure section. Also, the rationales behind most existing patches are documented in their respective files, read them (and their respective PRs/issues) for more context!

    Updating PlantUML

    PlantUML is a third-party library used by MarkBind to create UML diagrams. MarkBind runs the PlantUML JAR file found in packages/core/src/plugins/default when building the site to generate the diagrams.

    To update PlantUML to a newer version:

    1. Download the JAR file from PlantUML's website.
    2. Rename the file to plantuml.jar (if required), and replace the existing JAR file located in packages/core/src/plugins/default.
    3. Check the HTML pages that contain PlantUML diagrams, i.e. /userGuide/components/imagesAndDiagrams.html.

    Updating Bootstrap and Bootswatch

    As Bootswatch is built on Bootstrap, ensure that the versions of both are in sync to avoid unexpected differences in styling behavior between default and other themes. Both are currently using version 5.1.3.

    Setting up

    Writing Components


    @@ -247,50 +152,6 @@ - - - - - - - - diff --git a/devGuide/development/workflow.page-vue-render.js b/devGuide/development/workflow.page-vue-render.js index 3a4f2d59..e3bb9d34 100644 --- a/devGuide/development/workflow.page-vue-render.js +++ b/devGuide/development/workflow.page-vue-render.js @@ -1,7 +1,7 @@ var pageVueRenderFn = function anonymous( ) { -with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/devdocs/index.html","title":"Home"}},[_c('img',{attrs:{"src":"/devdocs/images/logo-darkbackground.svg","height":"20"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/index.html"}},[_v("HOME")])]),_v(" "),_c('div',{attrs:{"tags":"environment--dg environment--combined"}},[_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"sibling-or-child","href":"/devdocs/devGuide/index.html"}},[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/MarkBind/markbind","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Developer Guide")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_v("Contributing")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Onboarding Bootcamp\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_v("Introduction")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_v("Explore MarkBind as a User")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_v("Contribute to Documentation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_v("Fix a Bug")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_v("Implement a New Feature")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Development \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_v("Setting up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_v("Workflow")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_v("Writing Components")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_v("Writing Plugins")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_v("Migrating to TypeScript")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingNodeJs.html"}},[_v("Migrating Node.js")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Design \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("Project Structure")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_v("Server Side Rendering")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("GitHub Actions\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_v("Overview")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_v("markbind-action")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_v("markbind-reusable-workflows")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_v("Workflow Security")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_v("Project management")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Appendices \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_v("Style guides")])])])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_c('p',[_v("The sections below has more information about various stages of submitting a PR.")]),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('ul',[_m(7),_v(" "),_m(8),_v(" "),_c('li',[_c('p',[_v("Do set up your IDE debugger! We provide several sample configurations for "),_c('trigger',{attrs:{"trigger":"click","for":"webstorm-debug"}},[_v("WebStorm")]),_v(" and "),_c('trigger',{attrs:{"trigger":"click","for":"vs-code-debug"}},[_v("VS Code")]),_v(".")],1),_v(" "),_c('modal',{attrs:{"id":"webstorm-debug","large":""},scopedSlots:_u([{key:"header",fn:function(){return [_v("Debugging Configurations - WebStorm")]},proxy:true}])},[_v(" "),_c('p',[_v("Refer "),_c('a',{attrs:{"href":"https://blog.jetbrains.com/webstorm/2018/01/how-to-debug-with-webstorm/"}},[_v("here")]),_v(" for a quick guide on adding debugging and running configuration in WebStorm, and how to run them.")]),_v(" "),_c('p',[_v("Once done, see these screenshots for sample debugging configurations, and tweak them further to suit your needs.")]),_v(" "),_c('p',[_c('strong',[_v("1. Using the docs as a development environment")]),_v(", with:")]),_v(" "),_c('ul',{staticClass:"ms-4"},[_c('li',[_c('p',[_v("the "),_c('a',{attrs:{"tags":"environment--dg","href":"https://markbind.org/userGuide/cliCommands.html#serve-command"}},[_v("lazy reload"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" option to speed up page building")])]),_v(" "),_c('li',[_c('p',[_v("the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-d")]),_v(" developer option. (see "),_c('a',{attrs:{"href":"#editing-frontend-features"}},[_v("below")]),_v(")")]),_v(" "),_c('p',{staticClass:"mb-3"}),_v(" "),_c('p',[_c('a',{attrs:{"href":"/devdocs/images/debugger/WebStorm_1.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/devdocs/images/debugger/WebStorm_1.png","alt":""}})])])])]),_v(" "),_c('p',[_c('strong',[_v("2. Debugging all tests")]),_v(" in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run test")]),_v(" script:")]),_v(" "),_c('p',{staticClass:"ms-4"},[_c('a',{attrs:{"href":"/devdocs/images/debugger/WebStorm_2.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/devdocs/images/debugger/WebStorm_2.png","alt":""}})])]),_v(" "),_c('p',[_c('strong',[_v("3. Debugging only the cli package's tests")]),_v(":")]),_v(" "),_c('p',{staticClass:"ms-4"},[_c('a',{attrs:{"href":"/devdocs/images/debugger/WebStorm_3.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/devdocs/images/debugger/WebStorm_3.png","alt":""}})])])]),_v(" "),_c('modal',{attrs:{"id":"vs-code-debug","large":""},scopedSlots:_u([{key:"header",fn:function(){return [_v("Debugging Configurations - VS Code")]},proxy:true}])},[_v(" "),_c('p',[_v("Refer "),_c('a',{attrs:{"href":"https://code.visualstudio.com/docs/editor/debugging"}},[_v("here")]),_v(" for a general guide on adding and running debugging configurations in VS Code.")]),_v(" "),_c('p',[_v("In your "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".vscode/launch.json")]),_v(" file, you may use these sample configurations as a baseline, and tweak them as you see fit.")]),_v(" "),_c('p',[_c('strong',[_v("1. Using the docs as a development environment")]),_v(", with:")]),_v(" "),_c('ul',[_c('li',[_c('p',[_v("the "),_c('a',{attrs:{"tags":"environment--dg","href":"https://markbind.org/userGuide/cliCommands.html#serve-command"}},[_v("lazy reload"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" option to speed up page building")])]),_v(" "),_c('li',[_c('p',[_v("the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-d")]),_v(" developer option. (see "),_c('a',{attrs:{"href":"#editing-frontend-features"}},[_v("below")]),_v(")")]),_v(" "),_c('p',{staticClass:"mb-3"}),_v(" "),_c('div',{staticClass:"code-block"},[_c('div',{staticClass:"code-block-heading"},[_c('span',[_v("launch.json")])]),_c('div',{staticClass:"code-block-content"},[_c('pre',[_c('code',{pre:true,attrs:{"class":"ms-4 hljs json","heading":"launch.json"}},[_c('span',[_v("{\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"configurations\"")]),_v(": [\n")]),_c('span',[_v(" {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"type\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"node\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"request\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"launch\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Dev Docs\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"skipFiles\"")]),_v(": [\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"/**\"")]),_v("\n")]),_c('span',[_v(" ],\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"cwd\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"${workspaceFolder}/docs\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"program\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"${workspaceFolder}/packages/cli/index.js\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"args\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"serve\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"-o\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"-d\"")]),_v("]\n")]),_c('span',[_v(" }\n")]),_c('span',[_v(" ]\n")]),_c('span',[_v("}\n")])]),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])])])])]),_v(" "),_c('p',[_c('strong',[_v("2. Debugging all tests")]),_v(" in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run test")]),_v(" script:")]),_v(" "),_c('div',{staticClass:"code-block"},[_c('div',{staticClass:"code-block-heading"},[_c('span',[_v("launch.json")])]),_c('div',{staticClass:"code-block-content"},[_c('pre',[_c('code',{pre:true,attrs:{"class":"ms-4 hljs json","heading":"launch.json"}},[_c('span',[_v("{\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"configurations\"")]),_v(": [\n")]),_c('span',[_v(" {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"type\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"node\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"request\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"launch\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"test\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"skipFiles\"")]),_v(": [\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"/**\"")]),_v("\n")]),_c('span',[_v(" ],\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"cwd\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"${workspaceFolder}\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"runtimeExecutable\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"npm\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"runtimeArgs\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"run\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"test\"")]),_v("]\n")]),_c('span',[_v(" }\n")]),_c('span',[_v(" ]\n")]),_c('span',[_v("}\n")])]),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])])]),_c('p',[_c('strong',[_v("3. Debugging only the cli package's tests")]),_v(":")]),_v(" "),_c('div',{staticClass:"code-block"},[_c('div',{staticClass:"code-block-heading"},[_c('span',[_v("launch.json")])]),_c('div',{staticClass:"code-block-content"},[_c('pre',[_c('code',{pre:true,attrs:{"class":"ms-4 hljs json","heading":"launch.json"}},[_c('span',[_v("{\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"configurations\"")]),_v(": [\n")]),_c('span',[_v(" {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"type\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"node\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"request\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"launch\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"test cli\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"skipFiles\"")]),_v(": [\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"/**\"")]),_v("\n")]),_c('span',[_v(" ],\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"cwd\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"${workspaceFolder}/packages/cli\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"runtimeExecutable\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"npm\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"runtimeArgs\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"run\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"test\"")]),_v("]\n")]),_c('span',[_v(" }\n")]),_c('span',[_v(" ]\n")]),_c('span',[_v("}\n")])]),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])])])])],1)]),_v(" "),_m(9),_v(" "),_m(10),_v(" "),_m(11),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("You may want to use a tool like "),_c('a',{attrs:{"href":"https://www.git-town.com/"}},[_v("GitTown")]),_v(" to speed up the process.")])]),_v(" "),_m(12),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_m(15),_v(" "),_m(16),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_m(19),_v(" "),_c('div',{attrs:{"id":"workflow-testing"}},[_m(20),_v(" "),_c('p',[_v("Our test script does the following:")]),_v(" "),_m(21),_v(" "),_m(22),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("If you only want to run tests for one of the packages ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("packages/*")]),_v("), simply switch into the appropriate directory and use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run test")]),_v(" as well!")])]),_v(" "),_m(23),_v(" "),_m(24),_v(" "),_m(25),_v(" "),_m(26),_v(" "),_m(27),_v(" "),_c('p',[_v("After which, you can update the "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("These are located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("expected")]),_v(" folder in the test sites and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("__snapshots__")]),_v(" folder for unit tests")]},proxy:true}])},[_c('strong',[_v("expected")]),_v(" test files")]),_v(" with: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run updatetest")])],1),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("You should always check that the generated output is correct before committing any changes to the test sites.")]),_v(" "),_c('p',[_v("Note that some binary files such as images (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("inline-output.png")]),_v(") or fonts (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("material-icons-outlined.woff")]),_v(") could show up\nas uncommitted changes due to the way they are generated. If you are not directly modifying those files in your PR, you should "),_c('strong',[_v("discard those changes")]),_v(" and "),_c('strong',[_v("do not commit")]),_v(" them.")])]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_v("Here are the steps to solve merge conflicts in expected test files:")])]},proxy:true}])},[_v(" "),_c('ol',[_c('li',[_v("Ensure that your fork is synced with the upstream repository.")]),_v(" "),_c('li',[_v("Ensure that the master branch of your local repository is in sync with the master branch of your fork.\nPull from the fork into your local repository as needed.")]),_v(" "),_c('li',[_v("Checkout from your master branch to your PR branch.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git checkout [BRANCH NAME]")])])])]),_v(" "),_c('li',[_v("Merge your master branch into your PR branch.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git merge master")])])])]),_v(" "),_c('li',[_v("Accept all changes to any merge conflicts in the generated "),_c('strong',[_v("expected")]),_v(" test files.\n"),_c('ul',[_c('li',[_v("It does not matter which changes are accepted, as they will be overridden in the following step.")])])]),_v(" "),_c('li',[_v("Once your master branch has been successfully merged into your PR branch, run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run updatetest")]),_v(" to generate the latest test files.")])])]),_v(" "),_m(28),_v(" "),_c('p',[_v("When adding new features, you should also add new site content into an existing test site or create a new test site to demonstrate the new feature. This is to ensure that your feature can be tested by building that test site.")]),_v(" "),_m(29),_v(" "),_c('ol',[_m(30),_v(" "),_m(31),_v(" "),_c('li',[_m(32),_v(" "),_c('div',{staticClass:"code-block"},[_m(33),_c('div',{staticClass:"code-block-content"},[_c('pre',[_m(34),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])])])]),_v(" "),_m(35)]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("If creating a new test site instead, the directory name of the new test site should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("packages/cli/test/functional/testSites.js")]),_v(" file.")])]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("We do not commit the generated plantuml images in our "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test_site")]),_v(" to avoid non-related file changes after "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run updatetest")]),_v(".\nThe existing list of images to be ignored is maintained in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("packages/cli/test/functional/testSites.js")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitignore")]),_v(".\nThey should be updated accordingly if you are making changes to the plantuml content in our "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test_site")]),_v(".")])]),_v(" "),_m(36),_v(" "),_m(37),_v(" "),_m(38)],1),_v(" "),_m(39),_v(" "),_m(40),_v(" "),_m(41),_v(" "),_c('p',[_v("MarkBind's documentation currently has 3 tags:")]),_v(" "),_m(42),_v(" "),_c('p',[_v("To ensure that correct links are created, use tags with the links to selectively filter the correct link to be rendered for the right environment. When both the User Guide and the Developer Guide are deployed together, they have access to the files from each other, allowing the relative link to work. However, when they are deployed individually, this is not the case. Using absolute links creates the same effect as the relative link without having to have access to the files from the other guide.")]),_v(" "),_m(43),_v(" "),_m(44),_v(" "),_c('pre',[_m(45),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(46),_v(" "),_c('pre',[_m(47),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(48),_v(" "),_m(49),_v(" "),_c('pre',[_m(50),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(51),_v(" "),_c('pre',[_m(52),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(53),_v(" "),_m(54),_v(" "),_c('p',[_v("Before making a commit or pull request, you should lint your code by running the following commands from the root of your project:")]),_v(" "),_m(55),_v(" "),_m(56),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("ESLint has "),_c('a',{attrs:{"href":"https://eslint.org/docs/user-guide/integrations"}},[_v("integrations with popular editors")]),_v(". They offer features such as \"fix errors on save\", which will make development smoother.")])]),_v(" "),_m(57),_v(" "),_m(58),_v(" "),_c('p',[_v("To skip running the pre-commit hook or pre-push hook, you can use the --no-verify flag (e.g. git push --no-verify origin fork_branch).")]),_v(" "),_m(59),_v(" "),_m(60),_v(" "),_m(61),_v(" "),_m(62),_v(" "),_m(63),_v(" "),_m(64),_v(" "),_m(65),_v(" "),_m(66),_v(" "),_m(67),_v(" "),_m(68),_v(" "),_c('box',{attrs:{"type":"warning"}},[_c('p',[_v("Dependency updates are not trivial, and can be the source of subtle bugs. You should always check the respective dependency changelogs before doing so!")])]),_v(" "),_m(69),_v(" "),_c('p',[_v("There are a few ways to incorporate external packages into MarkBind, each with its pros and cons. The following table shows some of the common trade-offs:")]),_v(" "),_m(70),_c('p',[_v("As the choice is highly dependent on context and details of the implementation, below are some additional questions to ask before proceeding:")]),_v(" "),_m(71),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("Find out more about the key external libraries used in MarkBind from the "),_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("project structure")]),_v(" section. Also, the rationales behind most existing patches are documented in their respective files, read them (and their respective PRs/issues) for more context!")])]),_v(" "),_m(72),_v(" "),_m(73),_v(" "),_c('p',[_v("To update PlantUML to a newer version:")]),_v(" "),_m(74),_v(" "),_m(75),_v(" "),_c('p',[_v("As Bootswatch is built on Bootstrap, ensure that the versions of both are in sync to avoid unexpected differences in styling behavior between default and other themes. Both are currently using version 5.1.3.")]),_v(" "),_m(76),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#workflow"}},[_v("Workflowโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#writing-code"}},[_v("Writing codeโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#general-tips"}},[_v("General tipsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#keeping-your-fork-up-to-date"}},[_v("Keeping your fork up to dateโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-backend-features"}},[_v("Editing backend featuresโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-frontend-features"}},[_v("Editing frontend featuresโ€Ž")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#testing"}},[_v("Testingโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-and-writing-tests"}},[_v("Updating and writing testsโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-unit-tests"}},[_v("Updating unit testsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-functional-tests"}},[_v("Updating functional testsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-test-site-content"}},[_v("Adding test site contentโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-snapshot-tests-for-components"}},[_v("Adding snapshot tests for componentsโ€Ž")])])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#documenting"}},[_v("Documentingโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-intra-site-links-to-documentation"}},[_v("Adding Intra-Site Links to Documentationโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#developer-guide"}},[_v("Developer Guideโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-guide"}},[_v("User Guideโ€Ž")])])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#linting"}},[_v("Lintingโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#git-hooks"}},[_v("Git hooksโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#dependency-management"}},[_v("Dependency managementโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#to-add-a-dependency"}},[_v("To add a dependencyโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#to-delete-a-dependency"}},[_v("To delete a dependencyโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#to-update-a-dependency"}},[_v("To update a dependencyโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#points-for-consideration"}},[_v("Points for considerationโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-plantuml"}},[_v("Updating PlantUMLโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-bootstrap-and-bootswatch"}},[_v("Updating Bootstrap and Bootswatchโ€Ž")])])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(77)])} +with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/devdocs/index.html","title":"Home"}},[_c('img',{attrs:{"src":"/devdocs/images/logo-darkbackground.svg","height":"20"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/index.html"}},[_v("HOME")])]),_v(" "),_c('div',{attrs:{"tags":"environment--dg environment--combined"}},[_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"sibling-or-child","href":"/devdocs/devGuide/index.html"}},[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/MarkBind/markbind","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Developer Guide")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_v("Contributing")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Onboarding Bootcamp\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_v("Introduction")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_v("Explore MarkBind as a User")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_v("Contribute to Documentation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_v("Fix a Bug")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_v("Implement a New Feature")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Development \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_v("Setting up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_v("Workflow")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_v("Writing Components")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_v("Writing Plugins")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_v("Migrating to TypeScript")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingNodeJs.html"}},[_v("Migrating Node.js")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Design \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("Project Structure")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_v("Server Side Rendering")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("GitHub Actions\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_v("Overview")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_v("markbind-action")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_v("markbind-reusable-workflows")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_v("Workflow Security")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_v("Project management")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Appendices \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_v("Style guides")])])])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_c('p',[_v("The sections below has more information about various stages of submitting a PR.")]),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('ul',[_m(7),_v(" "),_m(8),_v(" "),_c('li',[_c('p',[_v("Do set up your IDE debugger! We provide several sample configurations for "),_c('trigger',{attrs:{"trigger":"click","for":"webstorm-debug"}},[_v("WebStorm")]),_v(" and "),_c('trigger',{attrs:{"trigger":"click","for":"vs-code-debug"}},[_v("VS Code")]),_v(".")],1),_v(" "),_c('modal',{attrs:{"id":"webstorm-debug","large":""},scopedSlots:_u([{key:"header",fn:function(){return [_v("Debugging Configurations - WebStorm")]},proxy:true}])},[_v(" "),_c('p',[_v("Refer "),_c('a',{attrs:{"href":"https://blog.jetbrains.com/webstorm/2018/01/how-to-debug-with-webstorm/"}},[_v("here")]),_v(" for a quick guide on adding debugging and running configuration in WebStorm, and how to run them.")]),_v(" "),_c('p',[_v("Once done, see these screenshots for sample debugging configurations, and tweak them further to suit your needs.")]),_v(" "),_c('p',[_c('strong',[_v("1. Using the docs as a development environment")]),_v(", with:")]),_v(" "),_c('ul',{staticClass:"ms-4"},[_c('li',[_c('p',[_v("the "),_c('a',{attrs:{"tags":"environment--dg","href":"https://markbind.org/userGuide/cliCommands.html#serve-command"}},[_v("lazy reload"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" option to speed up page building")])]),_v(" "),_c('li',[_c('p',[_v("the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-d")]),_v(" developer option. (see "),_c('a',{attrs:{"href":"#editing-frontend-features"}},[_v("below")]),_v(")")]),_v(" "),_c('p',{staticClass:"mb-3"}),_v(" "),_c('p',[_c('a',{attrs:{"href":"/devdocs/images/debugger/WebStorm_1.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/devdocs/images/debugger/WebStorm_1.png","alt":""}})])])])]),_v(" "),_c('p',[_c('strong',[_v("2. Debugging all tests")]),_v(" in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run test")]),_v(" script:")]),_v(" "),_c('p',{staticClass:"ms-4"},[_c('a',{attrs:{"href":"/devdocs/images/debugger/WebStorm_2.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/devdocs/images/debugger/WebStorm_2.png","alt":""}})])]),_v(" "),_c('p',[_c('strong',[_v("3. Debugging only the cli package's tests")]),_v(":")]),_v(" "),_c('p',{staticClass:"ms-4"},[_c('a',{attrs:{"href":"/devdocs/images/debugger/WebStorm_3.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/devdocs/images/debugger/WebStorm_3.png","alt":""}})])])]),_v(" "),_c('modal',{attrs:{"id":"vs-code-debug","large":""},scopedSlots:_u([{key:"header",fn:function(){return [_v("Debugging Configurations - VS Code")]},proxy:true}])},[_v(" "),_c('p',[_v("Refer "),_c('a',{attrs:{"href":"https://code.visualstudio.com/docs/editor/debugging"}},[_v("here")]),_v(" for a general guide on adding and running debugging configurations in VS Code.")]),_v(" "),_c('p',[_v("In your "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".vscode/launch.json")]),_v(" file, you may use these sample configurations as a baseline, and tweak them as you see fit.")]),_v(" "),_c('p',[_c('strong',[_v("1. Using the docs as a development environment")]),_v(", with:")]),_v(" "),_c('ul',[_c('li',[_c('p',[_v("the "),_c('a',{attrs:{"tags":"environment--dg","href":"https://markbind.org/userGuide/cliCommands.html#serve-command"}},[_v("lazy reload"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" option to speed up page building")])]),_v(" "),_c('li',[_c('p',[_v("the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-d")]),_v(" developer option. (see "),_c('a',{attrs:{"href":"#editing-frontend-features"}},[_v("below")]),_v(")")]),_v(" "),_c('p',{staticClass:"mb-3"}),_v(" "),_c('div',{staticClass:"code-block"},[_c('div',{staticClass:"code-block-heading"},[_c('span',[_v("launch.json")])]),_c('div',{staticClass:"code-block-content"},[_c('pre',[_c('code',{pre:true,attrs:{"class":"ms-4 hljs json","heading":"launch.json"}},[_c('span',[_v("{\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"configurations\"")]),_v(": [\n")]),_c('span',[_v(" {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"type\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"node\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"request\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"launch\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Dev Docs\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"skipFiles\"")]),_v(": [\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"/**\"")]),_v("\n")]),_c('span',[_v(" ],\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"cwd\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"${workspaceFolder}/docs\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"program\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"${workspaceFolder}/packages/cli/index.js\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"args\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"serve\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"-o\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"-d\"")]),_v("]\n")]),_c('span',[_v(" }\n")]),_c('span',[_v(" ]\n")]),_c('span',[_v("}\n")])]),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])])])])]),_v(" "),_c('p',[_c('strong',[_v("2. Debugging all tests")]),_v(" in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run test")]),_v(" script:")]),_v(" "),_c('div',{staticClass:"code-block"},[_c('div',{staticClass:"code-block-heading"},[_c('span',[_v("launch.json")])]),_c('div',{staticClass:"code-block-content"},[_c('pre',[_c('code',{pre:true,attrs:{"class":"ms-4 hljs json","heading":"launch.json"}},[_c('span',[_v("{\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"configurations\"")]),_v(": [\n")]),_c('span',[_v(" {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"type\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"node\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"request\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"launch\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"test\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"skipFiles\"")]),_v(": [\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"/**\"")]),_v("\n")]),_c('span',[_v(" ],\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"cwd\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"${workspaceFolder}\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"runtimeExecutable\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"npm\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"runtimeArgs\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"run\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"test\"")]),_v("]\n")]),_c('span',[_v(" }\n")]),_c('span',[_v(" ]\n")]),_c('span',[_v("}\n")])]),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])])]),_c('p',[_c('strong',[_v("3. Debugging only the cli package's tests")]),_v(":")]),_v(" "),_c('div',{staticClass:"code-block"},[_c('div',{staticClass:"code-block-heading"},[_c('span',[_v("launch.json")])]),_c('div',{staticClass:"code-block-content"},[_c('pre',[_c('code',{pre:true,attrs:{"class":"ms-4 hljs json","heading":"launch.json"}},[_c('span',[_v("{\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"configurations\"")]),_v(": [\n")]),_c('span',[_v(" {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"type\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"node\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"request\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"launch\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"test cli\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"skipFiles\"")]),_v(": [\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"/**\"")]),_v("\n")]),_c('span',[_v(" ],\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"cwd\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"${workspaceFolder}/packages/cli\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"runtimeExecutable\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"npm\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"runtimeArgs\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"run\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"test\"")]),_v("]\n")]),_c('span',[_v(" }\n")]),_c('span',[_v(" ]\n")]),_c('span',[_v("}\n")])]),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])])])])],1)]),_v(" "),_m(9),_v(" "),_m(10),_v(" "),_m(11),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("You may want to use a tool like "),_c('a',{attrs:{"href":"https://www.git-town.com/"}},[_v("GitTown")]),_v(" to speed up the process.")])]),_v(" "),_m(12),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_m(15),_v(" "),_m(16),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_m(19),_v(" "),_c('div',{attrs:{"id":"workflow-testing"}},[_m(20),_v(" "),_c('p',[_v("Our test script does the following:")]),_v(" "),_m(21),_v(" "),_m(22),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("If you only want to run tests for one of the packages ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("packages/*")]),_v("), simply switch into the appropriate directory and use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run test")]),_v(" as well!")])]),_v(" "),_m(23),_v(" "),_m(24),_v(" "),_m(25),_v(" "),_m(26),_v(" "),_m(27),_v(" "),_c('p',[_v("After which, you can update the "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("These are located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("expected")]),_v(" folder in the test sites and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("__snapshots__")]),_v(" folder for unit tests")]},proxy:true}])},[_c('strong',[_v("expected")]),_v(" test files")]),_v(" with: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run updatetest")])],1),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("You should always check that the generated output is correct before committing any changes to the test sites.")]),_v(" "),_c('p',[_v("Note that some binary files such as images (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("inline-output.png")]),_v(") or fonts (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("material-icons-outlined.woff")]),_v(") could show up\nas uncommitted changes due to the way they are generated. If you are not directly modifying those files in your PR, you should "),_c('strong',[_v("discard those changes")]),_v(" and "),_c('strong',[_v("do not commit")]),_v(" them.")])]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_v("Here are the steps to solve merge conflicts in expected test files:")])]},proxy:true}])},[_v(" "),_c('ol',[_c('li',[_v("Ensure that your fork is synced with the upstream repository.")]),_v(" "),_c('li',[_v("Ensure that the master branch of your local repository is in sync with the master branch of your fork.\nPull from the fork into your local repository as needed.")]),_v(" "),_c('li',[_v("Checkout from your master branch to your PR branch.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git checkout [BRANCH NAME]")])])])]),_v(" "),_c('li',[_v("Merge your master branch into your PR branch.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git merge master")])])])]),_v(" "),_c('li',[_v("Accept all changes to any merge conflicts in the generated "),_c('strong',[_v("expected")]),_v(" test files.\n"),_c('ul',[_c('li',[_v("It does not matter which changes are accepted, as they will be overridden in the following step.")])])]),_v(" "),_c('li',[_v("Once your master branch has been successfully merged into your PR branch, run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run updatetest")]),_v(" to generate the latest test files.")])])]),_v(" "),_m(28),_v(" "),_c('p',[_v("When adding new features, you should also add new site content into an existing test site or create a new test site to demonstrate the new feature. This is to ensure that your feature can be tested by building that test site.")]),_v(" "),_m(29),_v(" "),_c('ol',[_m(30),_v(" "),_m(31),_v(" "),_c('li',[_m(32),_v(" "),_c('div',{staticClass:"code-block"},[_m(33),_c('div',{staticClass:"code-block-content"},[_c('pre',[_m(34),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])])])]),_v(" "),_m(35)]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("If creating a new test site instead, the directory name of the new test site should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("packages/cli/test/functional/testSites.js")]),_v(" file.")])]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("We do not commit the generated plantuml images in our "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test_site")]),_v(" to avoid non-related file changes after "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run updatetest")]),_v(".\nThe existing list of images to be ignored is maintained in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("packages/cli/test/functional/testSites.js")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitignore")]),_v(".\nThey should be updated accordingly if you are making changes to the plantuml content in our "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test_site")]),_v(".")])]),_v(" "),_m(36),_v(" "),_m(37),_v(" "),_m(38)],1),_v(" "),_m(39),_v(" "),_m(40),_v(" "),_m(41),_v(" "),_c('p',[_v("MarkBind's documentation currently has 3 tags:")]),_v(" "),_m(42),_v(" "),_c('p',[_v("To ensure that correct links are created, use tags with the links to selectively filter the correct link to be rendered for the right environment. When both the User Guide and the Developer Guide are deployed together, they have access to the files from each other, allowing the relative link to work. However, when they are deployed individually, this is not the case. Using absolute links creates the same effect as the relative link without having to have access to the files from the other guide.")]),_v(" "),_m(43),_v(" "),_m(44),_v(" "),_c('pre',[_m(45),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(46),_v(" "),_c('pre',[_m(47),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(48),_v(" "),_m(49),_v(" "),_c('pre',[_m(50),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(51),_v(" "),_c('pre',[_m(52),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(53),_v(" "),_m(54),_v(" "),_c('p',[_v("Before making a commit or pull request, you should lint your code by running the following commands from the root of your project:")]),_v(" "),_m(55),_v(" "),_m(56),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("ESLint has "),_c('a',{attrs:{"href":"https://eslint.org/docs/user-guide/integrations"}},[_v("integrations with popular editors")]),_v(". They offer features such as \"fix errors on save\", which will make development smoother.")])]),_v(" "),_m(57),_v(" "),_m(58),_v(" "),_c('p',[_v("To skip running the pre-commit hook or pre-push hook, you can use the --no-verify flag (e.g. git push --no-verify origin fork_branch).")]),_v(" "),_m(59),_v(" "),_m(60),_v(" "),_m(61),_v(" "),_m(62),_v(" "),_m(63),_v(" "),_m(64),_v(" "),_m(65),_v(" "),_m(66),_v(" "),_m(67),_v(" "),_m(68),_v(" "),_c('box',{attrs:{"type":"warning"}},[_c('p',[_v("Dependency updates are not trivial, and can be the source of subtle bugs. You should always check the respective dependency changelogs before doing so!")])]),_v(" "),_m(69),_v(" "),_c('p',[_v("There are a few ways to incorporate external packages into MarkBind, each with its pros and cons. The following table shows some of the common trade-offs:")]),_v(" "),_m(70),_c('p',[_v("As the choice is highly dependent on context and details of the implementation, below are some additional questions to ask before proceeding:")]),_v(" "),_m(71),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("Find out more about the key external libraries used in MarkBind from the "),_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("project structure")]),_v(" section. Also, the rationales behind most existing patches are documented in their respective files, read them (and their respective PRs/issues) for more context!")])]),_v(" "),_m(72),_v(" "),_m(73),_v(" "),_c('p',[_v("To update PlantUML to a newer version:")]),_v(" "),_m(74),_v(" "),_m(75),_v(" "),_c('p',[_v("As Bootswatch is built on Bootstrap, ensure that the versions of both are in sync to avoid unexpected differences in styling behavior between default and other themes. Both are currently using version 5.1.3.")]),_v(" "),_m(76),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#workflow"}},[_v("Workflowโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#writing-code"}},[_v("Writing codeโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#general-tips"}},[_v("General tipsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#keeping-your-fork-up-to-date"}},[_v("Keeping your fork up to dateโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-backend-features"}},[_v("Editing backend featuresโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-frontend-features"}},[_v("Editing frontend featuresโ€Ž")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#testing"}},[_v("Testingโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-and-writing-tests"}},[_v("Updating and writing testsโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-unit-tests"}},[_v("Updating unit testsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-functional-tests"}},[_v("Updating functional testsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-test-site-content"}},[_v("Adding test site contentโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-snapshot-tests-for-components"}},[_v("Adding snapshot tests for componentsโ€Ž")])])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#documenting"}},[_v("Documentingโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-intra-site-links-to-documentation"}},[_v("Adding Intra-Site Links to Documentationโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#developer-guide"}},[_v("Developer Guideโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-guide"}},[_v("User Guideโ€Ž")])])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#linting"}},[_v("Lintingโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#git-hooks"}},[_v("Git hooksโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#dependency-management"}},[_v("Dependency managementโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#to-add-a-dependency"}},[_v("To add a dependencyโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#to-delete-a-dependency"}},[_v("To delete a dependencyโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#to-update-a-dependency"}},[_v("To update a dependencyโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#points-for-consideration"}},[_v("Points for considerationโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-plantuml"}},[_v("Updating PlantUMLโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-bootstrap-and-bootswatch"}},[_v("Updating Bootstrap and Bootswatchโ€Ž")])])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(77)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -236,6 +236,6 @@ with(this){return _c('h3',{attrs:{"id":"updating-bootstrap-and-bootswatch"}},[_v with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Setting up")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_c('span',[_c('span',[_v("Writing Components")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/development/writingComponents.html b/devGuide/development/writingComponents.html index 836b40bc..ae07776e 100644 --- a/devGuide/development/writingComponents.html +++ b/devGuide/development/writingComponents.html @@ -4,7 +4,7 @@ - MarkBind - Writing Components + MarkBind - Writing Components @@ -40,7 +40,7 @@ Bundlephobia may be useful to quickly look up the size of a package!

    Dependencies

    When choosing to use a third-party library or package, it should ideally be well-maintained and not have too many dependencies. While dependencies may be inevitable, a package with dependencies on large libraries may lag behind the most recent releases of these libraries, which may become a blocker for MarkBind to migrate to these recent releases as well.

    For instance, if bootstrap-vue depends on Bootstrap and Vue, we will need to wait for bootstrap-vue to migrate to the newest versions of both Bootstrap and Vue before MarkBind can migrate to these versions of Bootstrap and Vue as well.

    Feel free to raise any concerns during the initial discussion phase for other devs to weigh in on the tradeoffs!

    Attributes and Slots

    MarkBind components may support , or both. Some components allow users to supply the same content as either a slot or an attribute. -If an author provides the same content as both a slot and an attribute, in most cases, the slot should override the attribute.

    MarkBind should also log a warning to inform the author of this conflict!

    Workflow

    Writing Plugins


    +If an author provides the same content as both a slot and an attribute, in most cases, the slot should override the attribute.

    MarkBind should also log a warning to inform the author of this conflict!

    Workflow

    Writing Plugins


    @@ -49,50 +49,6 @@ - - - - - - - - diff --git a/devGuide/development/writingComponents.page-vue-render.js b/devGuide/development/writingComponents.page-vue-render.js index 6decb2f1..8dbf601e 100644 --- a/devGuide/development/writingComponents.page-vue-render.js +++ b/devGuide/development/writingComponents.page-vue-render.js @@ -104,6 +104,6 @@ with(this){return _c('h4',{attrs:{"id":"attributes-and-slots"}},[_v("Attributes with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Workflow")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_c('span',[_c('span',[_v("Writing Plugins")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/development/writingPlugins.html b/devGuide/development/writingPlugins.html index 8181832c..6b5914f8 100644 --- a/devGuide/development/writingPlugins.html +++ b/devGuide/development/writingPlugins.html @@ -4,7 +4,7 @@ - MarkBind - Writing Plugins + MarkBind - Writing Plugins @@ -48,26 +48,7 @@ return $.html(); }, }; -

    Tag Properties

    Tag properties are top-level properties of the tag configuration object. The following table lists what these properties are used for:

    Property Values Default Remarks
    isSpecial true or false false Allows configuring whether any tag is to be parsed "specially" like a <script> or <style> tag. This allows configuring custom tags that may contain conflicting syntax, such as the <puml> tag used for UML diagram generation.
    attributes Array of attribute configurations [] Contains the attribute configurations of the tags.

    Attribute Properties

    The following table lists what the possible properties for configuring the attributes of a tag, and what they are used for:

    Property Values Default Remarks
    name attribute name none The string name of the attribute.
    isRelative true or false false Should be true if this attribute may contain a relative link. This tells MarkBind to properly resolve such relative links when used in <include>s, by converting the link into a baseUrl preceded absolute link.
    isSourceFile true or false false Should be true if the attribute points to a source file. This allows flagging other source files to trigger page regeneration during live reload.

    Lifecycle hooks

    You may also need to maintain some plugin state during site generation, then reset this when the site or pages are regenerated.

    To do this, you may implement the beforeSiteGenerate method.

    • beforeSiteGenerate(): Called during initial site generation and subsequent regenerations during live preview. -
      • No return value is required.

    Writing Components

    Migrating to TypeScript


    +
    • No return value is required.

    Writing Components

    Migrating to TypeScript


    @@ -278,50 +183,6 @@ - - - - - - - - diff --git a/devGuide/development/writingPlugins.page-vue-render.js b/devGuide/development/writingPlugins.page-vue-render.js index ef20ecc3..e9d9da4f 100644 --- a/devGuide/development/writingPlugins.page-vue-render.js +++ b/devGuide/development/writingPlugins.page-vue-render.js @@ -1,7 +1,7 @@ var pageVueRenderFn = function anonymous( ) { -with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/devdocs/index.html","title":"Home"}},[_c('img',{attrs:{"src":"/devdocs/images/logo-darkbackground.svg","height":"20"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/index.html"}},[_v("HOME")])]),_v(" "),_c('div',{attrs:{"tags":"environment--dg environment--combined"}},[_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"sibling-or-child","href":"/devdocs/devGuide/index.html"}},[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/MarkBind/markbind","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Developer Guide")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_v("Contributing")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Onboarding Bootcamp\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_v("Introduction")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_v("Explore MarkBind as a User")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_v("Contribute to Documentation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_v("Fix a Bug")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_v("Implement a New Feature")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Development \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_v("Setting up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_v("Workflow")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_v("Writing Components")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_v("Writing Plugins")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_v("Migrating to TypeScript")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingNodeJs.html"}},[_v("Migrating Node.js")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Design \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("Project Structure")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_v("Server Side Rendering")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("GitHub Actions\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_v("Overview")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_v("markbind-action")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_v("markbind-reusable-workflows")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_v("Workflow Security")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_v("Project management")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Appendices \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_v("Style guides")])])])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_m(2),_v(" "),_c('p',[_v("This page details the available interfaces you may use to write plugins.")]),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('p',[_v("In most cases, this is sufficient, and more performant since this ties directly into MarkBind's HTML processing.")]),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_c('box',{attrs:{"type":"info"}},[_c('p',[_v("Note that both of these interfaces are executed independently on a page, a layout or an\n"),_c('popover',{scopedSlots:_u([{key:"content",fn:function(){return [_v("\nSomething referenced by a panel with a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("src")]),_v(" attribute ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("")]),_v(").\n")]},proxy:true}])},[_v("\nexternal\n")]),_v(".")],1),_v(" "),_c('p',[_v("That is, the DOM tree being processed during "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("processNode")]),_v(" and the content passed into "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("postRender")]),_v(" will belong to either one of these types of files.")])]),_v(" "),_m(9),_v(" "),_c('pre',[_m(10),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('box',{attrs:{"type":"warning"}},[_c('p',[_v("Remember to update "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("dg-site.json")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("site.json")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ug-site.json")]),_v(" in the docs folder when updating the requirements for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("site.json")]),_v(".")])]),_v(" "),_c('pre',[_m(11),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('pre',[_m(12),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(13),_v(" "),_m(14),_v(" "),_m(15),_v(" "),_c('box',{attrs:{"type":"success"},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_v("Local assets")])]},proxy:true}])},[_v(" "),_c('p',[_v("You can set an absolute or relative file path as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("src")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("href")]),_v(" attribute in your "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(" @@ -39,50 +39,6 @@ - - - - - - - - diff --git a/devGuide/githubActions/markbindAction.page-vue-render.js b/devGuide/githubActions/markbindAction.page-vue-render.js index 34ddbfee..d8613227 100644 --- a/devGuide/githubActions/markbindAction.page-vue-render.js +++ b/devGuide/githubActions/markbindAction.page-vue-render.js @@ -47,6 +47,6 @@ with(this){return _c('blockquote',[_c('ul',[_c('li',[_v("Create and validate a r with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("GitHub Actions: Overview")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_c('span',[_c('span',[_v("GitHub Actions: markbind-reusable-workflows")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/githubActions/markbindReusableWorkflows.html b/devGuide/githubActions/markbindReusableWorkflows.html index cde2491f..d4aa371f 100644 --- a/devGuide/githubActions/markbindReusableWorkflows.html +++ b/devGuide/githubActions/markbindReusableWorkflows.html @@ -4,7 +4,7 @@ - MarkBind - GitHub Actions: markbind-reusable-workflows + MarkBind - GitHub Actions: markbind-reusable-workflows @@ -26,7 +26,7 @@

    GitHub Actions: markbind-reusable-workflows

    GitHub Actions: markbind-reusable-workflows

    A list of reusable workflows that help to improve the CI/CD pipelines of MarkBind sites. It helps users to streamline their workflow by:

    • Making it easier to setup PR preview for a MarkBind site, including PRs from forks.
    • Making it easier to unpublish a PR preview site after merge/close.

    The source code is hosted alongside MarkBind/markbind-action.

    Development guide

    Refer to the development guide of markbind-action for the general approach. Take note of the following differences:

    • Understand the strength and limitations of reusable workflows.
    • Find out the details of the existing reusable workflows in its README.md.
    • As there is no need to release the reusable workflows in order for others to use, the workflows will be updated and maintained in the master branch (without doing a release).

    GitHub Actions: markbind-action

    GitHub Actions: Workflow Security


    +

    GitHub Actions: markbind-reusable-workflows

    GitHub Actions: markbind-reusable-workflows

    A list of reusable workflows that help to improve the CI/CD pipelines of MarkBind sites. It helps users to streamline their workflow by:

    • Making it easier to setup PR preview for a MarkBind site, including PRs from forks.
    • Making it easier to unpublish a PR preview site after merge/close.

    The source code is hosted alongside MarkBind/markbind-action.

    Development guide

    Refer to the development guide of markbind-action for the general approach. Take note of the following differences:

    • Understand the strength and limitations of reusable workflows.
    • Find out the details of the existing reusable workflows in its README.md.
    • As there is no need to release the reusable workflows in order for others to use, the workflows will be updated and maintained in the master branch (without doing a release).

    GitHub Actions: markbind-action

    GitHub Actions: Workflow Security


    @@ -35,50 +35,6 @@ - - - - - - - - diff --git a/devGuide/githubActions/markbindReusableWorkflows.page-vue-render.js b/devGuide/githubActions/markbindReusableWorkflows.page-vue-render.js index 9a949803..f037d4ee 100644 --- a/devGuide/githubActions/markbindReusableWorkflows.page-vue-render.js +++ b/devGuide/githubActions/markbindReusableWorkflows.page-vue-render.js @@ -26,6 +26,6 @@ with(this){return _c('ul',[_c('li',[_v("Understand the strength and limitations with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("GitHub Actions: markbind-action")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_c('span',[_c('span',[_v("GitHub Actions: Workflow Security")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/githubActions/overview.html b/devGuide/githubActions/overview.html index d47a16b5..4b734e4c 100644 --- a/devGuide/githubActions/overview.html +++ b/devGuide/githubActions/overview.html @@ -4,7 +4,7 @@ - MarkBind - GitHub Actions: Overview + MarkBind - GitHub Actions: Overview @@ -26,7 +26,7 @@

    GitHub Actions: Overview

    GitHub Actions: Overview

    A GitHub Action can perform a variety of tasks, including automating the build and deployment of a MarkBind site.

    Before any development, ensure you have a basic knowledge of GitHub Actions

    Server Side Rendering

    GitHub Actions: markbind-action


    +

    GitHub Actions: Overview

    GitHub Actions: Overview

    A GitHub Action can perform a variety of tasks, including automating the build and deployment of a MarkBind site.

    Before any development, ensure you have a basic knowledge of GitHub Actions

    Server Side Rendering

    GitHub Actions: markbind-action


    @@ -35,50 +35,6 @@ - - - - - - - - diff --git a/devGuide/githubActions/overview.page-vue-render.js b/devGuide/githubActions/overview.page-vue-render.js index de506302..e23ed009 100644 --- a/devGuide/githubActions/overview.page-vue-render.js +++ b/devGuide/githubActions/overview.page-vue-render.js @@ -23,6 +23,6 @@ with(this){return _c('ul',[_c('li',[_c('a',{attrs:{"href":"https://docs.github.c with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Server Side Rendering")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_c('span',[_c('span',[_v("GitHub Actions: markbind-action")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/githubActions/workflowSecurity.html b/devGuide/githubActions/workflowSecurity.html index b51490d3..ddcbb2d5 100644 --- a/devGuide/githubActions/workflowSecurity.html +++ b/devGuide/githubActions/workflowSecurity.html @@ -4,7 +4,7 @@ - MarkBind - GitHub Actions: Workflow Security + MarkBind - GitHub Actions: Workflow Security @@ -32,26 +32,7 @@ runs-on: ubuntu-latest permissions: contents: read -

    This method triggers workflows based on the latest commit of the pull request's base branch. Workflows on the base branch aren't affected by changes on feature branches, avoiding execution of malicious code in .

    This method could be limiting since the codebase checked out, using actions/checkout, is not up to date for the pull request. This means that the codebase checked out is not the codebase that is being tested. This could lead to false positives or false negatives in the testing process.

    Another solution that allows pull_request_target to work securely with actions/checkout on the pull request branch, is to implement running workflow only on approval by trusted users. This means that the workflow is only run after a user has checked for malicious code on the feature branch manually and approves the run.

    Information about reviewing workflows can be found here.

    Untrusted input

    Directly referencing values you do not control, such as echo โ€œ${{github.event.pull_request.title}}โ€ , can lead to security vulnerabilities since it can contain malicious code and lead to an injection attack.

    Instead use an action with arguments (recommended):

    uses: fakeaction/printtitle@v3 
 with: 
   title: ${{ github.event.pull_request.title }}
-

    GitHub Actions: markbind-reusable-workflows

    Project management


    +

    GitHub Actions: markbind-reusable-workflows

    Project management


    @@ -193,50 +117,6 @@ - - - - - - - - diff --git a/devGuide/githubActions/workflowSecurity.page-vue-render.js b/devGuide/githubActions/workflowSecurity.page-vue-render.js index cd4d1b8d..7110514b 100644 --- a/devGuide/githubActions/workflowSecurity.page-vue-render.js +++ b/devGuide/githubActions/workflowSecurity.page-vue-render.js @@ -1,7 +1,7 @@ var pageVueRenderFn = function anonymous( ) { -with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/devdocs/index.html","title":"Home"}},[_c('img',{attrs:{"src":"/devdocs/images/logo-darkbackground.svg","height":"20"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/index.html"}},[_v("HOME")])]),_v(" "),_c('div',{attrs:{"tags":"environment--dg environment--combined"}},[_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"sibling-or-child","href":"/devdocs/devGuide/index.html"}},[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/MarkBind/markbind","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Developer Guide")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_v("Contributing")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Onboarding Bootcamp\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_v("Introduction")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_v("Explore MarkBind as a User")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_v("Contribute to Documentation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_v("Fix a Bug")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_v("Implement a New Feature")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Development \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_v("Setting up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_v("Workflow")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_v("Writing Components")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_v("Writing Plugins")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_v("Migrating to TypeScript")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingNodeJs.html"}},[_v("Migrating Node.js")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Design \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("Project Structure")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_v("Server Side Rendering")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("GitHub Actions\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_v("Overview")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_v("markbind-action")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_v("markbind-reusable-workflows")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_v("Workflow Security")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_v("Project management")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Appendices \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_v("Style guides")])])])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('p',[_v("Every credential used in the workflow should have the minimum required permissions to execute the job. Without explicit specification of permissions, the default permissions are used, which are usually more permissive than necessary.")]),_v(" "),_m(4),_v(" "),_c('pre',[_m(5),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("permissions")]),_v(" can be restricted at the repo, workflow or job level. Pick the most restrictive level that still allows the workflow to function.")])]),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_c('p',[_v("Read access is the most permissive access to be given for pull requests from public forked repositories to maintain security.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Since MarkBind uses the forking workflow, workflows run on pull requests won't have write access, preventing them from doing things like adding comments or labels to pull requests.")])]),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_m(10),_v(" "),_c('pre',[_m(11),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("This method triggers workflows based on the latest commit of the pull request's base branch. Workflows on the base branch aren't affected by changes on feature branches, avoiding execution of malicious code in "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("Continuous Integration")]},proxy:true}])},[_v("CI")]),_v(".")],1),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("This method could be limiting since the codebase checked out, using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("actions/checkout")]),_v(", is not up to date for the pull request. This means that the codebase checked out is not the codebase that is being tested. This could lead to false positives or false negatives in the testing process.")])]),_v(" "),_m(12),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_m(15),_v(" "),_c('p',[_v("Instead use an action with arguments (recommended):")]),_v(" "),_c('pre',[_m(16),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("Or bind the value to an intermediate environment variable:")]),_v(" "),_c('pre',[_m(17),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(18),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#github-actions-workflow-security"}},[_v("GitHub Actions: Workflow Securityโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#minimally-scoped-credentials"}},[_v("Minimally scoped credentialsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#security-precautions-when-using-pull-request-target-event"}},[_v("Security precautions when using pull_request_target eventโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#untrusted-input"}},[_v("Untrusted inputโ€Ž")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(19)])} +with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/devdocs/index.html","title":"Home"}},[_c('img',{attrs:{"src":"/devdocs/images/logo-darkbackground.svg","height":"20"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/index.html"}},[_v("HOME")])]),_v(" "),_c('div',{attrs:{"tags":"environment--dg environment--combined"}},[_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"sibling-or-child","href":"/devdocs/devGuide/index.html"}},[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/MarkBind/markbind","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Developer Guide")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_v("Contributing")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Onboarding Bootcamp\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_v("Introduction")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_v("Explore MarkBind as a User")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_v("Contribute to Documentation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_v("Fix a Bug")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_v("Implement a New Feature")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Development \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_v("Setting up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_v("Workflow")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_v("Writing Components")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_v("Writing Plugins")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_v("Migrating to TypeScript")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingNodeJs.html"}},[_v("Migrating Node.js")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Design \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("Project Structure")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_v("Server Side Rendering")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("GitHub Actions\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_v("Overview")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_v("markbind-action")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_v("markbind-reusable-workflows")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_v("Workflow Security")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_v("Project management")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Appendices \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_v("Style guides")])])])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('p',[_v("Every credential used in the workflow should have the minimum required permissions to execute the job. Without explicit specification of permissions, the default permissions are used, which are usually more permissive than necessary.")]),_v(" "),_m(4),_v(" "),_c('pre',[_m(5),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("permissions")]),_v(" can be restricted at the repo, workflow or job level. Pick the most restrictive level that still allows the workflow to function.")])]),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_c('p',[_v("Read access is the most permissive access to be given for pull requests from public forked repositories to maintain security.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Since MarkBind uses the forking workflow, workflows run on pull requests won't have write access, preventing them from doing things like adding comments or labels to pull requests.")])]),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_m(10),_v(" "),_c('pre',[_m(11),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("This method triggers workflows based on the latest commit of the pull request's base branch. Workflows on the base branch aren't affected by changes on feature branches, avoiding execution of malicious code in "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("Continuous Integration")]},proxy:true}])},[_v("CI")]),_v(".")],1),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("This method could be limiting since the codebase checked out, using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("actions/checkout")]),_v(", is not up to date for the pull request. This means that the codebase checked out is not the codebase that is being tested. This could lead to false positives or false negatives in the testing process.")])]),_v(" "),_m(12),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_m(15),_v(" "),_c('p',[_v("Instead use an action with arguments (recommended):")]),_v(" "),_c('pre',[_m(16),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("Or bind the value to an intermediate environment variable:")]),_v(" "),_c('pre',[_m(17),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_m(18),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#github-actions-workflow-security"}},[_v("GitHub Actions: Workflow Securityโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#minimally-scoped-credentials"}},[_v("Minimally scoped credentialsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#security-precautions-when-using-pull-request-target-event"}},[_v("Security precautions when using pull_request_target eventโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#untrusted-input"}},[_v("Untrusted inputโ€Ž")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(19)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -62,6 +62,6 @@ with(this){return _c('code',{pre:true,attrs:{"class":"hljs yaml"}},[_c('span',[_ with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("GitHub Actions: markbind-reusable-workflows")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_c('span',[_c('span',[_v("Project management")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/index.html b/devGuide/index.html index 4676e430..4ef62df7 100644 --- a/devGuide/index.html +++ b/devGuide/index.html @@ -4,7 +4,7 @@ - MarkBind + MarkBind @@ -14,7 +14,7 @@
    +
      @@ -25,50 +25,6 @@ - - - - - - - - diff --git a/devGuide/index.page-vue-render.js b/devGuide/index.page-vue-render.js index 6be909aa..1bb68a68 100644 --- a/devGuide/index.page-vue-render.js +++ b/devGuide/index.page-vue-render.js @@ -5,6 +5,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" }; var pageVueStaticRenderFns = [function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/projectManagement.html b/devGuide/projectManagement.html index 5958b12a..eb64fba6 100644 --- a/devGuide/projectManagement.html +++ b/devGuide/projectManagement.html @@ -4,7 +4,7 @@ - MarkBind - Project management + MarkBind - Project management @@ -48,26 +48,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Open Bugs</title> <link rel="stylesheet" href="../markbind/css/bootstrap.min.css"> -

      If any other lines changed, that likely means the functional tests weren't updated in a pull request. Do revert everything done so far, and make a pull request specifically to fix that first!

    • If core-web package bundle was updated earlier: also ensure that the updated bundles are copied to each of the expected test site's folders.

      • We do this for each MarkBind release (rather than require contributors to update the bundles for each affected PR), in order to reduce unnecessary merge conflicts. It also makes it easier for the maintainers to vet the changes.
      • Typically, the bundle will be updated automatically in the expected test site's folders after running npm run updatetest in the previous step.

    • Combine the changes that you made in the last two steps with the version commit generated by lerna version. To do so, amend the version commit and version tag by doing the following โ€” take note to change vA.B.C to the new version.

      $ git commit -a --amend --reuse-message vA.B.C
 $ git tag --force vA.B.C     # to reassign the tag to the newly amended commit
-

    • Push the new commit and version tag generated by npm (change vA.B.C to the new version's string accordingly).

      $ git push upstream master
 $ git push upstream vA.B.C
-

    • Publish by running npx lerna publish from-git. You should receive a notification by npm that the publish is successful.

    • Smoke test the new version by installing the new version (run npm i -g markbind-cli@A.B.C) and playing around with it a bit to ensure that it works.

      • If you used npm link for your project, ensure that you try the new release on another platform that doesn't use npm link, so that we can be sure the end-users can install and use the new version.
      • You can also try the new release on a project that uses MarkBind as a local dev-dependency.

    • Verify the website at markbind.org has been updated. For example, you can look at the footer of the website to see if the version number is updated.

      Note that it may take a few minutes for the website to be updated and you may need to check it in an incognito window to avoid caching.

      The deployment is automated. However, if it doesn't deploy properly for the release, do the following:

      $ npm run deploy:ug
-
    • Multiple contribution types can be included at once or updated later on.
      • E.g. "@all-contributors please add tlylt for code, doc"
    • Contribution types can be updated later on.
      • E.g "@all-contributors please add tlylt for code"
      • Some time later: "@all-contributors please add tlylt for doc"
      • Result: 'tlylt' will be updated to have both icons(code and doc)

      • Managing the repository

      Projects

      As the number of issues increases, prioritising and triaging work may become more tricky even with labels. We may want to prioritise certain issues for particular version releases, or to work towards an overall vision of MarkBind. For this purpose, it may be useful to use GitHub Projects.

      Instructions:

      1. Read through the issues in the repository to understand what's in the backlog.
      2. Decide what goals the team is working towards. Examples: "Better Logging", "Necessary Updates", "User Demand", "Bugfix", and "Developer Experience".
      3. Create the GitHub project (keeping in mind how long it should take) and update the project details.
      4. Add relevant issues to the project and use it to track progress.

      Some tips / principles from current use:

      • Don't treat the project as a strict guide, only a tool to prioritise tasks and discover issues to work on. If another issue catches your fancy or an urgent fix comes up that is not on the roadmap, you can work on that instead.
      • These projects are "product roadmaps" to help teams communicate and collaborate.
      • This roadmap tracks some bigger issues that MarkBind aims to focus on.
      • The main goal is to triage issues and perhaps track progress in the repository perhaps on a yearly basis. -
        • You can triage issues into more than just "todo" - this roadmap used in 2024 into "KIV/Discussion", "Todo", and "Implementation Needed"; the latter is used for issues that are very straightforward, while the first was used for issues where the precise implementation might require some discussion or be more complex.
        • You can write project details to clarify your project organisation.
        • You can use multiple views, such as Kanban, tables, or calendar, depending on what best suits your needs.
        • You can use custom fields - this roadmap used in 2024 categorised the issues into bigger picture goals that were set earlier.

      Other Notes

      About Milestones

      Previously, we used milestones to help manage versions, adding a milestone to an issue once related PRs had been merged. However, there was confusion over the use of milestones and labels and adding a milestone was often forgotten. Hence, ultimately it was not sufficiently useful to the team.

      GitHub Actions: Workflow Security

      Appendix: Style guides


      +
      • You can triage issues into more than just "todo" - this roadmap used in 2024 into "KIV/Discussion", "Todo", and "Implementation Needed"; the latter is used for issues that are very straightforward, while the first was used for issues where the precise implementation might require some discussion or be more complex.
      • You can write project details to clarify your project organisation.
      • You can use multiple views, such as Kanban, tables, or calendar, depending on what best suits your needs.
      • You can use custom fields - this roadmap used in 2024 categorised the issues into bigger picture goals that were set earlier.

      Other Notes

      About Milestones

      Previously, we used milestones to help manage versions, adding a milestone to an issue once related PRs had been merged. However, there was confusion over the use of milestones and labels and adding a milestone was often forgotten. Hence, ultimately it was not sufficiently useful to the team.

      GitHub Actions: Workflow Security

      Appendix: Style guides


      @@ -385,50 +271,6 @@ - - - - - - - - diff --git a/devGuide/projectManagement.page-vue-render.js b/devGuide/projectManagement.page-vue-render.js index b6a97584..94dadbcb 100644 --- a/devGuide/projectManagement.page-vue-render.js +++ b/devGuide/projectManagement.page-vue-render.js @@ -1,7 +1,7 @@ var pageVueRenderFn = function anonymous( ) { -with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/devdocs/index.html","title":"Home"}},[_c('img',{attrs:{"src":"/devdocs/images/logo-darkbackground.svg","height":"20"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/index.html"}},[_v("HOME")])]),_v(" "),_c('div',{attrs:{"tags":"environment--dg environment--combined"}},[_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"sibling-or-child","href":"/devdocs/devGuide/index.html"}},[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/MarkBind/markbind","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Developer Guide")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_v("Contributing")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Onboarding Bootcamp\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_v("Introduction")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_v("Explore MarkBind as a User")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_v("Contribute to Documentation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_v("Fix a Bug")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_v("Implement a New Feature")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Development \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_v("Setting up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_v("Workflow")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_v("Writing Components")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_v("Writing Plugins")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_v("Migrating to TypeScript")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingNodeJs.html"}},[_v("Migrating Node.js")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Design \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("Project Structure")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_v("Server Side Rendering")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("GitHub Actions\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_v("Overview")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_v("markbind-action")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_v("markbind-reusable-workflows")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_v("Workflow Security")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_v("Project management")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Appendices \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_v("Style guides")])])])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('ul',[_m(6),_v(" "),_c('li',[_m(7),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This is to allow other developers the chance to review the PR, and delay the merge if there's any significant problems. Not everyone is available all of the time, so please be patient.")])])],1)]),_v(" "),_m(8),_v(" "),_c('ol',[_c('li',[_m(9),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Rationale:")]),_v(" This is because we do not ask PR authors to rebase their PRs, but the master branch may have since been updated. It is possible for tests to pass on their branch, only to fail when integrating the changes with the master")]),_v(" "),_c('p',[_v("This is possible even if GitHub "),_c('em',[_v("doesn't")]),_v(" complain about any merge conflict!")])])],1),_v(" "),_m(10),_v(" "),_c('li',[_m(11),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Reason:")]),_v(" The release manager may not review all PRs, so please add the label to highlight the version impact of the PR.")])])],1),_v(" "),_c('li',[_m(12),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Reason:")]),_v(" The release manager may not have the full details of the PR, so please work with the PR author to prepare a release note (if applicable) in the PR description.")])])],1),_v(" "),_c('li',[_m(13),_v(" "),_m(14),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" The above should be performed with caution as force pushing rewrites the Git history, which might cause conflicts with any on-going work. You would also need write/push access to master.")])])],1)]),_v(" "),_m(15),_v(" "),_c('ol',[_c('li',[_m(16),_v(" "),_c('ul',[_m(17),_v(" "),_c('li',[_m(18),_v(" "),_c('ul',[_c('li',[_v("To check if you are in the MarkBind organization, go to your npm profile and check if MarkBind is listed under organizations.\n"),_c('pic',{attrs:{"src":"/images/npm-profile.jpg","width":"100%","alt":"npm profile"}},[_v("\nExample of profile that has been added to Markbind organisation\n")])],1),_v(" "),_m(19),_v(" "),_c('li',[_v("Notably, the first three are packages that we publish every release while the last one has since become a private package consumed internally.")])])])])]),_v(" "),_m(20),_v(" "),_m(21),_v(" "),_c('li',[_m(22),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Double check that the PRs are appropriate for the new version. Review the definition of "),_c('a',{attrs:{"href":"https://semver.org/"}},[_v("SEMVER")]),_v(" and the impact of the PRs.")]),_v(" "),_c('li',[_v("We will specify updated version numbers exactly to ensure that each version will consistently fetch the same versioned internal packages.")]),_v(" "),_c('li',[_v("The end result of this command is version commit with an appropriate tag. We will make use of the generated tag and commit message later.")]),_v(" "),_c('li',[_v("Do not push this commit to the remote repository yet.")])])])],1),_v(" "),_c('li',[_m(23),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('ul',[_c('li',[_v("If there were no changes to the files in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("packages/core-web")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("packages/vue-components")]),_v(" since the last release of MarkBind, you may observe no changes. Simply proceed with the rest of the steps.")]),_v(" "),_c('li',[_v("If there are font files in the diff, and you are sure that there were no changes to the font files, you may ignore & discard the changes.")]),_v(" "),_c('li',[_v("Typically, the following files will be updated:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind.min.js")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind.min.css")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("vuecommonappfactory.min.js")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("vuecommonappfactory.min.css")])])])])])])],1),_v(" "),_c('li',[_m(24),_v(" "),_m(25),_v(" "),_c('pre',[_m(26),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("If any other lines changed, that likely means the functional tests weren't updated in a pull request. Do revert everything done so far, and make a pull request specifically to fix that first!")])]),_v(" "),_c('li',[_m(27),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("We do this for each MarkBind release (rather than require contributors to update the bundles for each affected PR), in order to reduce unnecessary merge conflicts. It also makes it easier for the maintainers to vet the changes.")]),_v(" "),_c('li',[_v("Typically, the bundle will be updated automatically in the expected test site's folders after running "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run updatetest")]),_v(" in the previous step.")])])])],1),_v(" "),_c('li',[_m(28),_v(" "),_c('pre',[_m(29),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])]),_v(" "),_c('li',[_m(30),_v(" "),_c('pre',[_m(31),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])]),_v(" "),_m(32),_v(" "),_c('li',[_m(33),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If you used "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm link")]),_v(" for your project, ensure that you "),_c('mark',[_v("try the new release on another platform")]),_v(" that doesn't use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm link")]),_v(", so that we can be sure the end-users can install and use the new version.")]),_v(" "),_c('li',[_v("You can also try the new release on a project that uses MarkBind as a local dev-dependency.")])])])],1),_v(" "),_c('li',[_m(34),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note that it may take a few minutes for the website to be updated and you may need to check it in an incognito window to avoid caching.")])]),_v(" "),_c('p',[_v("The deployment is automated. However, if it doesn't deploy properly for the release, do the following:")]),_v(" "),_c('pre',[_m(35),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])],1),_v(" "),_c('li',[_m(36),_v(" "),_m(37),_v(" "),_c('p',[_v("b. Click \"Draft a new release\".")]),_v(" "),_m(38),_v(" "),_c('p',[_v("d. For the release title, leave it blank.")]),_v(" "),_c('p',[_v("e. Press the \"Generate release notes\" button to automatically add the list of PRs merged for this release.")]),_v(" "),_c('p',[_v("f. For the main body, use the following template:")]),_v(" "),_c('pre',[_m(39),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("Thoroughly review and categorize each PR to its appropriate section within the release notes. If needed, provide additional explanations for clarity. Any sections without a corresponding PR can be omitted.")]),_v(" "),_c('p',[_v("An example of a release note draft (taken from v1.18.0):")]),_v(" "),_c('pre',[_m(40),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"toggleCodeBlockWrap(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"id":"path17964","d":"M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L\n 2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094\n 9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L\n 7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L\n 11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375\n 6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625\n 10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719\n 12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156\n 11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375\n 5.1054688 z "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")]),_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("f. Click \"Publish release\".")])]),_v(" "),_m(41)]),_v(" "),_m(42),_v(" "),_m(43),_v(" "),_m(44),_v(" "),_m(45),_v(" "),_m(46),_v(" "),_c('p',[_v("To simplify the process, use the all-contributors bot that has been installed in the repository to trigger a PR that will add a new contributor.")]),_v(" "),_c('p',[_v("Example workflow:")]),_v(" "),_m(47),_v(" "),_c('p',[_v("Note that:")]),_v(" "),_m(48),_v(" "),_m(49),_v(" "),_m(50),_v(" "),_m(51),_v(" "),_m(52),_v(" "),_m(53),_v(" "),_m(54),_v(" "),_m(55),_v(" "),_m(56),_v(" "),_c('box',{attrs:{"type":"info","icon-color":"info","seamless":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_v("About Milestones")])]},proxy:true},{key:"icon",fn:function(){return [_c('span',{staticClass:"fas fa-question",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("Previously, we used milestones to help manage versions, adding a milestone to an issue once related PRs had been merged. However, there was confusion over the use of milestones and labels and adding a milestone was often forgotten. Hence, ultimately it was not sufficiently useful to the team.")])]),_v(" "),_m(57),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#project-management"}},[_v("Project managementโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#managing-prs"}},[_v("Managing PRsโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#approval"}},[_v("Approvalโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#merging"}},[_v("Mergingโ€Ž")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#doing-a-release"}},[_v("Doing a Releaseโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#acknowledging-contributors"}},[_v("Acknowledging Contributorsโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#view-all-contributors"}},[_v("View all contributorsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#add-new-contributors"}},[_v("Add new contributorsโ€Ž")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#managing-the-repository"}},[_v("Managing the repositoryโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#projects"}},[_v("Projectsโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#instructions"}},[_v("Instructions:โ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#some-tips-principles-from-current-use"}},[_v("Some tips / principles from current use:โ€Ž")])])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#other-notes"}},[_v("Other Notesโ€Ž")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(58)])} +with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/devdocs/index.html","title":"Home"}},[_c('img',{attrs:{"src":"/devdocs/images/logo-darkbackground.svg","height":"20"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/index.html"}},[_v("HOME")])]),_v(" "),_c('div',{attrs:{"tags":"environment--dg environment--combined"}},[_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"sibling-or-child","href":"/devdocs/devGuide/index.html"}},[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"highlight-on":"exact","href":"/devdocs/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/MarkBind/markbind","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Developer Guide")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/devGuide.html"}},[_v("Contributing")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Onboarding Bootcamp\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/intro.html"}},[_v("Introduction")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/exploreMarkBind.html"}},[_v("Explore MarkBind as a User")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/contributeToDocs.html"}},[_v("Contribute to Documentation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/fixABug.html"}},[_v("Fix a Bug")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/bootcamp/implementAFeature.html"}},[_v("Implement a New Feature")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Development \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/settingUp.html"}},[_v("Setting up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/workflow.html"}},[_v("Workflow")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingComponents.html"}},[_v("Writing Components")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/writingPlugins.html"}},[_v("Writing Plugins")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingToTypeScript.html"}},[_v("Migrating to TypeScript")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/development/migratingNodeJs.html"}},[_v("Migrating Node.js")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Design \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/projectStructure.html"}},[_v("Project Structure")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/design/serverSideRendering.html"}},[_v("Server Side Rendering")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("GitHub Actions\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/overview.html"}},[_v("Overview")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindAction.html"}},[_v("markbind-action")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/markbindReusableWorkflows.html"}},[_v("markbind-reusable-workflows")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_v("Workflow Security")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_v("Project management")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Appendices \n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_v("Style guides")])])])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('ul',[_m(6),_v(" "),_c('li',[_m(7),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This is to allow other developers the chance to review the PR, and delay the merge if there's any significant problems. Not everyone is available all of the time, so please be patient.")])])],1)]),_v(" "),_m(8),_v(" "),_c('ol',[_c('li',[_m(9),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Rationale:")]),_v(" This is because we do not ask PR authors to rebase their PRs, but the master branch may have since been updated. It is possible for tests to pass on their branch, only to fail when integrating the changes with the master")]),_v(" "),_c('p',[_v("This is possible even if GitHub "),_c('em',[_v("doesn't")]),_v(" complain about any merge conflict!")])])],1),_v(" "),_m(10),_v(" "),_c('li',[_m(11),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Reason:")]),_v(" The release manager may not review all PRs, so please add the label to highlight the version impact of the PR.")])])],1),_v(" "),_c('li',[_m(12),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Reason:")]),_v(" The release manager may not have the full details of the PR, so please work with the PR author to prepare a release note (if applicable) in the PR description.")])])],1),_v(" "),_c('li',[_m(13),_v(" "),_m(14),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" The above should be performed with caution as force pushing rewrites the Git history, which might cause conflicts with any on-going work. You would also need write/push access to master.")])])],1)]),_v(" "),_m(15),_v(" "),_c('ol',[_c('li',[_m(16),_v(" "),_c('ul',[_m(17),_v(" "),_c('li',[_m(18),_v(" "),_c('ul',[_c('li',[_v("To check if you are in the MarkBind organization, go to your npm profile and check if MarkBind is listed under organizations.\n"),_c('pic',{attrs:{"src":"/images/npm-profile.jpg","width":"100%","alt":"npm profile"}},[_v("\nExample of profile that has been added to Markbind organisation\n")])],1),_v(" "),_m(19),_v(" "),_c('li',[_v("Notably, the first three are packages that we publish every release while the last one has since become a private package consumed internally.")])])])])]),_v(" "),_m(20),_v(" "),_m(21),_v(" "),_c('li',[_m(22),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Double check that the PRs are appropriate for the new version. Review the definition of "),_c('a',{attrs:{"href":"https://semver.org/"}},[_v("SEMVER")]),_v(" and the impact of the PRs.")]),_v(" "),_c('li',[_v("We will specify updated version numbers exactly to ensure that each version will consistently fetch the same versioned internal packages.")]),_v(" "),_c('li',[_v("The end result of this command is version commit with an appropriate tag. We will make use of the generated tag and commit message later.")]),_v(" "),_c('li',[_v("Do not push this commit to the remote repository yet.")])])])],1),_v(" "),_c('li',[_m(23),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('ul',[_c('li',[_v("If there were no changes to the files in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("packages/core-web")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("packages/vue-components")]),_v(" since the last release of MarkBind, you may observe no changes. Simply proceed with the rest of the steps.")]),_v(" "),_c('li',[_v("If there are font files in the diff, and you are sure that there were no changes to the font files, you may ignore & discard the changes.")]),_v(" "),_c('li',[_v("Typically, the following files will be updated:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind.min.js")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind.min.css")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("vuecommonappfactory.min.js")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("vuecommonappfactory.min.css")])])])])])])],1),_v(" "),_c('li',[_m(24),_v(" "),_m(25),_v(" "),_c('pre',[_m(26),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("If any other lines changed, that likely means the functional tests weren't updated in a pull request. Do revert everything done so far, and make a pull request specifically to fix that first!")])]),_v(" "),_c('li',[_m(27),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("We do this for each MarkBind release (rather than require contributors to update the bundles for each affected PR), in order to reduce unnecessary merge conflicts. It also makes it easier for the maintainers to vet the changes.")]),_v(" "),_c('li',[_v("Typically, the bundle will be updated automatically in the expected test site's folders after running "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm run updatetest")]),_v(" in the previous step.")])])])],1),_v(" "),_c('li',[_m(28),_v(" "),_c('pre',[_m(29),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])]),_v(" "),_c('li',[_m(30),_v(" "),_c('pre',[_m(31),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])]),_v(" "),_m(32),_v(" "),_c('li',[_m(33),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If you used "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm link")]),_v(" for your project, ensure that you "),_c('mark',[_v("try the new release on another platform")]),_v(" that doesn't use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("npm link")]),_v(", so that we can be sure the end-users can install and use the new version.")]),_v(" "),_c('li',[_v("You can also try the new release on a project that uses MarkBind as a local dev-dependency.")])])])],1),_v(" "),_c('li',[_m(34),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note that it may take a few minutes for the website to be updated and you may need to check it in an incognito window to avoid caching.")])]),_v(" "),_c('p',[_v("The deployment is automated. However, if it doesn't deploy properly for the release, do the following:")]),_v(" "),_c('pre',[_m(35),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])])],1),_v(" "),_c('li',[_m(36),_v(" "),_m(37),_v(" "),_c('p',[_v("b. Click \"Draft a new release\".")]),_v(" "),_m(38),_v(" "),_c('p',[_v("d. For the release title, leave it blank.")]),_v(" "),_c('p',[_v("e. Press the \"Generate release notes\" button to automatically add the list of PRs merged for this release.")]),_v(" "),_c('p',[_v("f. For the main body, use the following template:")]),_v(" "),_c('pre',[_m(39),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("Thoroughly review and categorize each PR to its appropriate section within the release notes. If needed, provide additional explanations for clarity. Any sections without a corresponding PR can be omitted.")]),_v(" "),_c('p',[_v("An example of a release note draft (taken from v1.18.0):")]),_v(" "),_c('pre',[_m(40),_c('div',{staticClass:"function-btn-container"},[_c('button',{staticClass:"function-btn d-print-none",attrs:{"onclick":"copyCodeBlock(this)"}},[_v("\n "),_c('div',{staticClass:"function-btn-body"},[_v("\n \n"),_c('svg',{attrs:{"xmlns":"http://www.w3.org/2000/svg","xmlns:xlink":"http://www.w3.org/1999/xlink","width":"18","height":"18","viewBox":"0 0 18 18","version":"1.1"}},[_v("\n "),_c('g',{attrs:{"id":"surface1"}},[_v("\n "),_c('path',{attrs:{"d":"M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844\n 1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438\n 1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4\n 4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906\n 15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844\n 14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L\n 5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "}}),_v("\n ")]),_v("\n")]),_v("\n\n ")]),_v("\n ")])])]),_c('p',[_v("f. Click \"Publish release\".")])]),_v(" "),_m(41)]),_v(" "),_m(42),_v(" "),_m(43),_v(" "),_m(44),_v(" "),_m(45),_v(" "),_m(46),_v(" "),_c('p',[_v("To simplify the process, use the all-contributors bot that has been installed in the repository to trigger a PR that will add a new contributor.")]),_v(" "),_c('p',[_v("Example workflow:")]),_v(" "),_m(47),_v(" "),_c('p',[_v("Note that:")]),_v(" "),_m(48),_v(" "),_m(49),_v(" "),_m(50),_v(" "),_m(51),_v(" "),_m(52),_v(" "),_m(53),_v(" "),_m(54),_v(" "),_m(55),_v(" "),_m(56),_v(" "),_c('box',{attrs:{"type":"info","icon-color":"info","seamless":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_v("About Milestones")])]},proxy:true},{key:"icon",fn:function(){return [_c('span',{staticClass:"fas fa-question",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("Previously, we used milestones to help manage versions, adding a milestone to an issue once related PRs had been merged. However, there was confusion over the use of milestones and labels and adding a milestone was often forgotten. Hence, ultimately it was not sufficiently useful to the team.")])]),_v(" "),_m(57),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#project-management"}},[_v("Project managementโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#managing-prs"}},[_v("Managing PRsโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#approval"}},[_v("Approvalโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#merging"}},[_v("Mergingโ€Ž")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#doing-a-release"}},[_v("Doing a Releaseโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#acknowledging-contributors"}},[_v("Acknowledging Contributorsโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#view-all-contributors"}},[_v("View all contributorsโ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#add-new-contributors"}},[_v("Add new contributorsโ€Ž")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#managing-the-repository"}},[_v("Managing the repositoryโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#projects"}},[_v("Projectsโ€Ž")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#instructions"}},[_v("Instructions:โ€Ž")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#some-tips-principles-from-current-use"}},[_v("Some tips / principles from current use:โ€Ž")])])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#other-notes"}},[_v("Other Notesโ€Ž")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(58)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -179,6 +179,6 @@ with(this){return _c('h2',{attrs:{"id":"other-notes"}},[_v("Other Notes"),_c('a' with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/githubActions/workflowSecurity.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("GitHub Actions: Workflow Security")])])])])]),_v(" "),_c('p',[_c('span',{staticClass:"float-end"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/styleGuides.html"}},[_c('span',[_c('span',[_v("Appendix: Style guides")]),_v(" "),_c('span',{staticClass:"far fa-arrow-alt-circle-right",attrs:{"aria-hidden":"true"}})])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/devGuide/styleGuides.html b/devGuide/styleGuides.html index 05ddf336..ca2e8871 100644 --- a/devGuide/styleGuides.html +++ b/devGuide/styleGuides.html @@ -4,7 +4,7 @@ - MarkBind - Appendix: Style guides + MarkBind - Appendix: Style guides @@ -26,7 +26,7 @@

      Appendix: Style guides

      Appendix: Style guides

      Our coding standards are mostly based on those at se-education.org/guides.

      Project management


      +

      Appendix: Style guides

      Appendix: Style guides

      Our coding standards are mostly based on those at se-education.org/guides.

      Project management


      @@ -35,50 +35,6 @@ - - - - - - - - diff --git a/devGuide/styleGuides.page-vue-render.js b/devGuide/styleGuides.page-vue-render.js index db480685..6ebbcf48 100644 --- a/devGuide/styleGuides.page-vue-render.js +++ b/devGuide/styleGuides.page-vue-render.js @@ -20,6 +20,6 @@ with(this){return _c('ul',[_c('li',[_c('a',{attrs:{"href":"https://se-education. with(this){return _c('div',{staticClass:"clearfix"},[_c('p',[_c('span',{staticClass:"float-start"},[_c('a',{staticClass:"btn btn-light",attrs:{"href":"/devdocs/devGuide/projectManagement.html"}},[_c('span',[_c('span',{staticClass:"far fa-arrow-alt-circle-left",attrs:{"aria-hidden":"true"}}),_v(" "),_c('span',[_v("Project management")])])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/index.html b/index.html index 2e32ab33..abf302da 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ - MarkBind - Generate More Dynamic Websites from Markdown Text + MarkBind - Generate More Dynamic Websites from Markdown Text @@ -16,7 +16,7 @@ Search

        Developer Guide

        If you are a user, please visit MarkBind.org instead. -

        This is the latest Developer Guide for MarkBind.

        For contributors: please access the Developer Guide here

        +

        This is the latest Developer Guide for MarkBind.

        For contributors: please access the Developer Guide here

        @@ -25,50 +25,6 @@ - - - - - - - - diff --git a/index.page-vue-render.js b/index.page-vue-render.js index 64f4146c..1b621e21 100644 --- a/index.page-vue-render.js +++ b/index.page-vue-render.js @@ -11,6 +11,6 @@ with(this){return _c('h2',{attrs:{"id":"developer-guide"}},[_v("Developer Guide" with(this){return _c('p',[_v("For contributors: please access the Developer Guide "),_c('a',{attrs:{"href":"/devdocs/devGuide/index.html"}},[_v("here")])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/plugins/dataTable/datatables-additional.css b/plugins/dataTable/datatables-additional.css deleted file mode 100644 index b0249f09..00000000 --- a/plugins/dataTable/datatables-additional.css +++ /dev/null @@ -1,10 +0,0 @@ -/* Make the search box left-aligned */ -div.dt-container div.dt-search { - text-align: left; - padding: 10px 0; -} - -div.dt-container { - /* Necessary to suppress the vertical scrollbar */ - overflow-y: hidden; -} diff --git a/plugins/dataTable/datatables.min.css b/plugins/dataTable/datatables.min.css deleted file mode 100644 index 51aa17fe..00000000 --- a/plugins/dataTable/datatables.min.css +++ /dev/null @@ -1,19 +0,0 @@ -/* - * This combined file was created by the DataTables downloader builder: - * https://datatables.net/download - * - * To rebuild or modify this file with the latest versions of the included - * software please visit: - * https://datatables.net/download/#bs5/jq-3.7.0/dt-2.0.2 - * - * Included libraries: - * jQuery 3 3.7.0, DataTables 2.0.2 - */ - -:root{--dt-row-selected: 13, 110, 253;--dt-row-selected-text: 255, 255, 255;--dt-row-selected-link: 9, 10, 11;--dt-row-stripe: 0, 0, 0;--dt-row-hover: 0, 0, 0;--dt-column-ordering: 0, 0, 0;--dt-html-background: white}:root.dark{--dt-html-background: rgb(33, 37, 41)}table.dataTable td.dt-control{text-align:center;cursor:pointer}table.dataTable td.dt-control:before{display:inline-block;box-sizing:border-box;content:"";border-top:5px solid transparent;border-left:10px solid rgba(0, 0, 0, 0.5);border-bottom:5px solid transparent;border-right:0px solid transparent}table.dataTable tr.dt-hasChild td.dt-control:before{border-top:10px solid rgba(0, 0, 0, 0.5);border-left:5px solid transparent;border-bottom:0px solid transparent;border-right:5px solid transparent}html.dark table.dataTable td.dt-control:before,:root[data-bs-theme=dark] table.dataTable td.dt-control:before{border-left-color:rgba(255, 255, 255, 0.5)}html.dark table.dataTable tr.dt-hasChild td.dt-control:before,:root[data-bs-theme=dark] table.dataTable tr.dt-hasChild td.dt-control:before{border-top-color:rgba(255, 255, 255, 0.5);border-left-color:transparent}div.dt-scroll-body thead tr,div.dt-scroll-body tfoot tr{height:0}div.dt-scroll-body thead tr th,div.dt-scroll-body thead tr td,div.dt-scroll-body tfoot tr th,div.dt-scroll-body tfoot tr td{height:0 !important;padding-top:0px !important;padding-bottom:0px !important;border-top-width:0px !important;border-bottom-width:0px !important}div.dt-scroll-body thead tr th div.dt-scroll-sizing,div.dt-scroll-body thead tr td div.dt-scroll-sizing,div.dt-scroll-body tfoot tr th div.dt-scroll-sizing,div.dt-scroll-body tfoot tr td div.dt-scroll-sizing{height:0 !important;overflow:hidden !important}table.dataTable thead>tr>th:active,table.dataTable thead>tr>td:active{outline:none}table.dataTable thead>tr>th.dt-orderable-asc span.dt-column-order:before,table.dataTable thead>tr>th.dt-ordering-asc span.dt-column-order:before,table.dataTable thead>tr>td.dt-orderable-asc span.dt-column-order:before,table.dataTable thead>tr>td.dt-ordering-asc span.dt-column-order:before{position:absolute;display:block;bottom:50%;content:"โ–ฒ";content:"โ–ฒ"/""}table.dataTable thead>tr>th.dt-orderable-desc span.dt-column-order:after,table.dataTable thead>tr>th.dt-ordering-desc span.dt-column-order:after,table.dataTable thead>tr>td.dt-orderable-desc span.dt-column-order:after,table.dataTable thead>tr>td.dt-ordering-desc span.dt-column-order:after{position:absolute;display:block;top:50%;content:"โ–ผ";content:"โ–ผ"/""}table.dataTable thead>tr>th.dt-orderable-asc,table.dataTable thead>tr>th.dt-orderable-desc,table.dataTable thead>tr>th.dt-ordering-asc,table.dataTable thead>tr>th.dt-ordering-desc,table.dataTable thead>tr>td.dt-orderable-asc,table.dataTable thead>tr>td.dt-orderable-desc,table.dataTable thead>tr>td.dt-ordering-asc,table.dataTable thead>tr>td.dt-ordering-desc{position:relative;padding-right:30px}table.dataTable thead>tr>th.dt-orderable-asc span.dt-column-order,table.dataTable thead>tr>th.dt-orderable-desc span.dt-column-order,table.dataTable thead>tr>th.dt-ordering-asc span.dt-column-order,table.dataTable thead>tr>th.dt-ordering-desc span.dt-column-order,table.dataTable thead>tr>td.dt-orderable-asc span.dt-column-order,table.dataTable thead>tr>td.dt-orderable-desc span.dt-column-order,table.dataTable thead>tr>td.dt-ordering-asc span.dt-column-order,table.dataTable thead>tr>td.dt-ordering-desc span.dt-column-order{position:absolute;right:12px;top:0;bottom:0;width:12px}table.dataTable thead>tr>th.dt-orderable-asc span.dt-column-order:before,table.dataTable thead>tr>th.dt-orderable-asc span.dt-column-order:after,table.dataTable thead>tr>th.dt-orderable-desc span.dt-column-order:before,table.dataTable thead>tr>th.dt-orderable-desc span.dt-column-order:after,table.dataTable thead>tr>th.dt-ordering-asc span.dt-column-order:before,table.dataTable thead>tr>th.dt-ordering-asc span.dt-column-order:after,table.dataTable thead>tr>th.dt-ordering-desc span.dt-column-order:before,table.dataTable thead>tr>th.dt-ordering-desc span.dt-column-order:after,table.dataTable thead>tr>td.dt-orderable-asc span.dt-column-order:before,table.dataTable thead>tr>td.dt-orderable-asc span.dt-column-order:after,table.dataTable thead>tr>td.dt-orderable-desc span.dt-column-order:before,table.dataTable thead>tr>td.dt-orderable-desc span.dt-column-order:after,table.dataTable thead>tr>td.dt-ordering-asc span.dt-column-order:before,table.dataTable thead>tr>td.dt-ordering-asc span.dt-column-order:after,table.dataTable thead>tr>td.dt-ordering-desc span.dt-column-order:before,table.dataTable thead>tr>td.dt-ordering-desc span.dt-column-order:after{left:0;opacity:.125;line-height:9px;font-size:.8em}table.dataTable thead>tr>th.dt-orderable-asc,table.dataTable thead>tr>th.dt-orderable-desc,table.dataTable thead>tr>td.dt-orderable-asc,table.dataTable thead>tr>td.dt-orderable-desc{cursor:pointer}table.dataTable thead>tr>th.dt-orderable-asc:hover,table.dataTable thead>tr>th.dt-orderable-desc:hover,table.dataTable thead>tr>td.dt-orderable-asc:hover,table.dataTable thead>tr>td.dt-orderable-desc:hover{outline:2px solid rgba(0, 0, 0, 0.05);outline-offset:-2px}table.dataTable thead>tr>th.dt-ordering-asc span.dt-column-order:before,table.dataTable thead>tr>th.dt-ordering-desc span.dt-column-order:after,table.dataTable thead>tr>td.dt-ordering-asc span.dt-column-order:before,table.dataTable thead>tr>td.dt-ordering-desc span.dt-column-order:after{opacity:.6}table.dataTable thead>tr>th.sorting_desc_disabled span.dt-column-order:after,table.dataTable thead>tr>th.sorting_asc_disabled span.dt-column-order:before,table.dataTable thead>tr>td.sorting_desc_disabled span.dt-column-order:after,table.dataTable thead>tr>td.sorting_asc_disabled span.dt-column-order:before{display:none}table.dataTable thead>tr>th:active,table.dataTable thead>tr>td:active{outline:none}div.dt-scroll-body>table.dataTable>thead>tr>th,div.dt-scroll-body>table.dataTable>thead>tr>td{overflow:hidden}:root.dark table.dataTable thead>tr>th.dt-orderable-asc:hover,:root.dark table.dataTable thead>tr>th.dt-orderable-desc:hover,:root.dark table.dataTable thead>tr>td.dt-orderable-asc:hover,:root.dark table.dataTable thead>tr>td.dt-orderable-desc:hover,:root[data-bs-theme=dark] table.dataTable thead>tr>th.dt-orderable-asc:hover,:root[data-bs-theme=dark] table.dataTable thead>tr>th.dt-orderable-desc:hover,:root[data-bs-theme=dark] table.dataTable thead>tr>td.dt-orderable-asc:hover,:root[data-bs-theme=dark] table.dataTable thead>tr>td.dt-orderable-desc:hover{outline:2px solid rgba(255, 255, 255, 0.05)}div.dt-processing{position:absolute;top:50%;left:50%;width:200px;margin-left:-100px;margin-top:-22px;text-align:center;padding:2px;z-index:10}div.dt-processing>div:last-child{position:relative;width:80px;height:15px;margin:1em auto}div.dt-processing>div:last-child>div{position:absolute;top:0;width:13px;height:13px;border-radius:50%;background:rgb(13, 110, 253);background:rgb(var(--dt-row-selected));animation-timing-function:cubic-bezier(0, 1, 1, 0)}div.dt-processing>div:last-child>div:nth-child(1){left:8px;animation:datatables-loader-1 .6s infinite}div.dt-processing>div:last-child>div:nth-child(2){left:8px;animation:datatables-loader-2 .6s infinite}div.dt-processing>div:last-child>div:nth-child(3){left:32px;animation:datatables-loader-2 .6s infinite}div.dt-processing>div:last-child>div:nth-child(4){left:56px;animation:datatables-loader-3 .6s infinite}@keyframes datatables-loader-1{0%{transform:scale(0)}100%{transform:scale(1)}}@keyframes datatables-loader-3{0%{transform:scale(1)}100%{transform:scale(0)}}@keyframes datatables-loader-2{0%{transform:translate(0, 0)}100%{transform:translate(24px, 0)}}table.dataTable.nowrap th,table.dataTable.nowrap td{white-space:nowrap}table.dataTable th,table.dataTable td{box-sizing:border-box}table.dataTable th.dt-left,table.dataTable td.dt-left{text-align:left}table.dataTable th.dt-center,table.dataTable td.dt-center{text-align:center}table.dataTable th.dt-right,table.dataTable td.dt-right{text-align:right}table.dataTable th.dt-justify,table.dataTable td.dt-justify{text-align:justify}table.dataTable th.dt-nowrap,table.dataTable td.dt-nowrap{white-space:nowrap}table.dataTable th.dt-empty,table.dataTable td.dt-empty{text-align:center;vertical-align:top}table.dataTable th.dt-type-numeric,table.dataTable th.dt-type-date,table.dataTable td.dt-type-numeric,table.dataTable td.dt-type-date{text-align:right}table.dataTable thead th,table.dataTable thead td,table.dataTable tfoot th,table.dataTable tfoot td{text-align:left}table.dataTable thead th.dt-head-left,table.dataTable thead td.dt-head-left,table.dataTable tfoot th.dt-head-left,table.dataTable tfoot td.dt-head-left{text-align:left}table.dataTable thead th.dt-head-center,table.dataTable thead td.dt-head-center,table.dataTable tfoot th.dt-head-center,table.dataTable tfoot td.dt-head-center{text-align:center}table.dataTable thead th.dt-head-right,table.dataTable thead td.dt-head-right,table.dataTable tfoot th.dt-head-right,table.dataTable tfoot td.dt-head-right{text-align:right}table.dataTable thead th.dt-head-justify,table.dataTable thead td.dt-head-justify,table.dataTable tfoot th.dt-head-justify,table.dataTable tfoot td.dt-head-justify{text-align:justify}table.dataTable thead th.dt-head-nowrap,table.dataTable thead td.dt-head-nowrap,table.dataTable tfoot th.dt-head-nowrap,table.dataTable tfoot td.dt-head-nowrap{white-space:nowrap}table.dataTable tbody th.dt-body-left,table.dataTable tbody td.dt-body-left{text-align:left}table.dataTable tbody th.dt-body-center,table.dataTable tbody td.dt-body-center{text-align:center}table.dataTable tbody th.dt-body-right,table.dataTable tbody td.dt-body-right{text-align:right}table.dataTable tbody th.dt-body-justify,table.dataTable tbody td.dt-body-justify{text-align:justify}table.dataTable tbody th.dt-body-nowrap,table.dataTable tbody td.dt-body-nowrap{white-space:nowrap}/*! Bootstrap 5 integration for DataTables - * - * ยฉ2020 SpryMedia Ltd, all rights reserved. - * License: MIT datatables.net/license/mit - */table.table.dataTable{clear:both;margin-bottom:0;max-width:none;border-spacing:0}table.table.dataTable.table-striped>tbody>tr:nth-of-type(2n+1)>*{box-shadow:none}table.table.dataTable>:not(caption)>*>*{background-color:transparent}table.table.dataTable>tbody>tr{background-color:transparent}table.table.dataTable>tbody>tr.selected>*{box-shadow:inset 0 0 0 9999px rgb(13, 110, 253);box-shadow:inset 0 0 0 9999px rgb(var(--dt-row-selected));color:rgb(255, 255, 255);color:rgb(var(--dt-row-selected-text))}table.table.dataTable>tbody>tr.selected a{color:rgb(9, 10, 11);color:rgb(var(--dt-row-selected-link))}table.table.dataTable.table-striped>tbody>tr:nth-of-type(2n+1)>*{box-shadow:inset 0 0 0 9999px rgba(var(--dt-row-stripe), 0.05)}table.table.dataTable.table-striped>tbody>tr:nth-of-type(2n+1).selected>*{box-shadow:inset 0 0 0 9999px rgba(13, 110, 253, 0.95);box-shadow:inset 0 0 0 9999px rgba(var(--dt-row-selected), 0.95)}table.table.dataTable.table-hover>tbody>tr:hover>*{box-shadow:inset 0 0 0 9999px rgba(var(--dt-row-hover), 0.075)}table.table.dataTable.table-hover>tbody>tr.selected:hover>*{box-shadow:inset 0 0 0 9999px rgba(13, 110, 253, 0.975);box-shadow:inset 0 0 0 9999px rgba(var(--dt-row-selected), 0.975)}div.dt-container div.dt-length label{font-weight:normal;text-align:left;white-space:nowrap}div.dt-container div.dt-length select{width:auto;display:inline-block;margin-right:.5em}div.dt-container div.dt-search{text-align:right}div.dt-container div.dt-search label{font-weight:normal;white-space:nowrap;text-align:left}div.dt-container div.dt-search input{margin-left:.5em;display:inline-block;width:auto}div.dt-container div.dt-info{padding-top:.85em}div.dt-container div.dt-paging{margin:0}div.dt-container div.dt-paging ul.pagination{margin:2px 0;flex-wrap:wrap}div.dt-container div.dt-row{position:relative}div.dt-scroll-head table.dataTable{margin-bottom:0 !important}div.dt-scroll-body{border-bottom-color:var(--bs-border-color);border-bottom-width:var(--bs-border-width);border-bottom-style:solid}div.dt-scroll-body>table{border-top:none;margin-top:0 !important;margin-bottom:0 !important}div.dt-scroll-body>table>tbody>tr:first-child{border-top-width:0}div.dt-scroll-body>table>thead>tr{border-width:0 !important}div.dt-scroll-body>table>tbody>tr:last-child>*{border-bottom:none}div.dt-scroll-foot>.dt-scroll-footInner{box-sizing:content-box}div.dt-scroll-foot>.dt-scroll-footInner>table{margin-top:0 !important;border-top:none}div.dt-scroll-foot>.dt-scroll-footInner>table>tfoot>tr:first-child{border-top-width:0 !important}@media screen and (max-width: 767px){div.dt-container div.dt-length,div.dt-container div.dt-search,div.dt-container div.dt-info,div.dt-container div.dt-paging{text-align:center}div.dt-container .row{--bs-gutter-y: 0.5rem}div.dt-container div.dt-paging ul.pagination{justify-content:center !important}}table.dataTable.table-sm>thead>tr th.dt-orderable-asc,table.dataTable.table-sm>thead>tr th.dt-orderable-desc,table.dataTable.table-sm>thead>tr th.dt-ordering-asc,table.dataTable.table-sm>thead>tr th.dt-ordering-desc,table.dataTable.table-sm>thead>tr td.dt-orderable-asc,table.dataTable.table-sm>thead>tr td.dt-orderable-desc,table.dataTable.table-sm>thead>tr td.dt-ordering-asc,table.dataTable.table-sm>thead>tr td.dt-ordering-desc{padding-right:20px}table.dataTable.table-sm>thead>tr th.dt-orderable-asc span.dt-column-order,table.dataTable.table-sm>thead>tr th.dt-orderable-desc span.dt-column-order,table.dataTable.table-sm>thead>tr th.dt-ordering-asc span.dt-column-order,table.dataTable.table-sm>thead>tr th.dt-ordering-desc span.dt-column-order,table.dataTable.table-sm>thead>tr td.dt-orderable-asc span.dt-column-order,table.dataTable.table-sm>thead>tr td.dt-orderable-desc span.dt-column-order,table.dataTable.table-sm>thead>tr td.dt-ordering-asc span.dt-column-order,table.dataTable.table-sm>thead>tr td.dt-ordering-desc span.dt-column-order{right:5px}div.dt-scroll-head table.table-bordered{border-bottom-width:0}div.table-responsive>div.dt-container>div.row{margin:0}div.table-responsive>div.dt-container>div.row>div[class^=col-]:first-child{padding-left:0}div.table-responsive>div.dt-container>div.row>div[class^=col-]:last-child{padding-right:0}:root[data-bs-theme=dark]{--dt-row-hover: 255, 255, 255;--dt-row-stripe: 255, 255, 255;--dt-column-ordering: 255, 255, 255} - - diff --git a/plugins/dataTable/datatables.min.js b/plugins/dataTable/datatables.min.js deleted file mode 100644 index a32eac58..00000000 --- a/plugins/dataTable/datatables.min.js +++ /dev/null @@ -1,26 +0,0 @@ -/* - * This combined file was created by the DataTables downloader builder: - * https://datatables.net/download - * - * To rebuild or modify this file with the latest versions of the included - * software please visit: - * https://datatables.net/download/#bs5/jq-3.7.0/dt-2.0.2 - * - * Included libraries: - * jQuery 3 3.7.0, DataTables 2.0.2 - */ - -/*! jQuery v3.7.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(ie,e){"use strict";var oe=[],r=Object.getPrototypeOf,ae=oe.slice,g=oe.flat?function(e){return oe.flat.call(e)}:function(e){return oe.concat.apply([],e)},s=oe.push,se=oe.indexOf,n={},i=n.toString,ue=n.hasOwnProperty,o=ue.toString,a=o.call(Object),le={},v=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},y=function(e){return null!=e&&e===e.window},C=ie.document,u={type:!0,src:!0,nonce:!0,noModule:!0};function m(e,t,n){var r,i,o=(n=n||C).createElement("script");if(o.text=e,t)for(r in u)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function x(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[i.call(e)]||"object":typeof e}var t="3.7.0",l=/HTML$/i,ce=function(e,t){return new ce.fn.init(e,t)};function c(e){var t=!!e&&"length"in e&&e.length,n=x(e);return!v(e)&&!y(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+ge+")"+ge+"*"),x=new RegExp(ge+"|>"),j=new RegExp(g),A=new RegExp("^"+t+"$"),D={ID:new RegExp("^#("+t+")"),CLASS:new RegExp("^\\.("+t+")"),TAG:new RegExp("^("+t+"|[*])"),ATTR:new RegExp("^"+p),PSEUDO:new RegExp("^"+g),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+ge+"*(even|odd|(([+-]|)(\\d*)n|)"+ge+"*(?:([+-]|)"+ge+"*(\\d+)|))"+ge+"*\\)|)","i"),bool:new RegExp("^(?:"+f+")$","i"),needsContext:new RegExp("^"+ge+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+ge+"*((?:-\\d)?\\d*)"+ge+"*\\)|)(?=[^-]|$)","i")},N=/^(?:input|select|textarea|button)$/i,q=/^h\d$/i,L=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,H=/[+~]/,O=new RegExp("\\\\[\\da-fA-F]{1,6}"+ge+"?|\\\\([^\\r\\n\\f])","g"),P=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},R=function(){V()},M=J(function(e){return!0===e.disabled&&fe(e,"fieldset")},{dir:"parentNode",next:"legend"});try{k.apply(oe=ae.call(ye.childNodes),ye.childNodes),oe[ye.childNodes.length].nodeType}catch(e){k={apply:function(e,t){me.apply(e,ae.call(t))},call:function(e){me.apply(e,ae.call(arguments,1))}}}function I(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(V(e),e=e||T,C)){if(11!==p&&(u=L.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return k.call(n,a),n}else if(f&&(a=f.getElementById(i))&&I.contains(e,a)&&a.id===i)return k.call(n,a),n}else{if(u[2])return k.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&e.getElementsByClassName)return k.apply(n,e.getElementsByClassName(i)),n}if(!(h[t+" "]||d&&d.test(t))){if(c=t,f=e,1===p&&(x.test(t)||m.test(t))){(f=H.test(t)&&z(e.parentNode)||e)==e&&le.scope||((s=e.getAttribute("id"))?s=ce.escapeSelector(s):e.setAttribute("id",s=S)),o=(l=Y(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+Q(l[o]);c=l.join(",")}try{return k.apply(n,f.querySelectorAll(c)),n}catch(e){h(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return re(t.replace(ve,"$1"),e,n,r)}function W(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function F(e){return e[S]=!0,e}function $(e){var t=T.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function B(t){return function(e){return fe(e,"input")&&e.type===t}}function _(t){return function(e){return(fe(e,"input")||fe(e,"button"))&&e.type===t}}function X(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&M(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function U(a){return F(function(o){return o=+o,F(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function z(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}function V(e){var t,n=e?e.ownerDocument||e:ye;return n!=T&&9===n.nodeType&&n.documentElement&&(r=(T=n).documentElement,C=!ce.isXMLDoc(T),i=r.matches||r.webkitMatchesSelector||r.msMatchesSelector,ye!=T&&(t=T.defaultView)&&t.top!==t&&t.addEventListener("unload",R),le.getById=$(function(e){return r.appendChild(e).id=ce.expando,!T.getElementsByName||!T.getElementsByName(ce.expando).length}),le.disconnectedMatch=$(function(e){return i.call(e,"*")}),le.scope=$(function(){return T.querySelectorAll(":scope")}),le.cssHas=$(function(){try{return T.querySelector(":has(*,:jqfake)"),!1}catch(e){return!0}}),le.getById?(b.filter.ID=function(e){var t=e.replace(O,P);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(O,P);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):t.querySelectorAll(e)},b.find.CLASS=function(e,t){if("undefined"!=typeof t.getElementsByClassName&&C)return t.getElementsByClassName(e)},d=[],$(function(e){var t;r.appendChild(e).innerHTML="",e.querySelectorAll("[selected]").length||d.push("\\["+ge+"*(?:value|"+f+")"),e.querySelectorAll("[id~="+S+"-]").length||d.push("~="),e.querySelectorAll("a#"+S+"+*").length||d.push(".#.+[+~]"),e.querySelectorAll(":checked").length||d.push(":checked"),(t=T.createElement("input")).setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),r.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&d.push(":enabled",":disabled"),(t=T.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||d.push("\\["+ge+"*name"+ge+"*="+ge+"*(?:''|\"\")")}),le.cssHas||d.push(":has"),d=d.length&&new RegExp(d.join("|")),l=function(e,t){if(e===t)return a=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!le.sortDetached&&t.compareDocumentPosition(e)===n?e===T||e.ownerDocument==ye&&I.contains(ye,e)?-1:t===T||t.ownerDocument==ye&&I.contains(ye,t)?1:o?se.call(o,e)-se.call(o,t):0:4&n?-1:1)}),T}for(e in I.matches=function(e,t){return I(e,null,null,t)},I.matchesSelector=function(e,t){if(V(e),C&&!h[t+" "]&&(!d||!d.test(t)))try{var n=i.call(e,t);if(n||le.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){h(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(O,P),e[3]=(e[3]||e[4]||e[5]||"").replace(O,P),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||I.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&I.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return D.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&j.test(n)&&(t=Y(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(O,P).toLowerCase();return"*"===e?function(){return!0}:function(e){return fe(e,t)}},CLASS:function(e){var t=s[e+" "];return t||(t=new RegExp("(^|"+ge+")"+e+"("+ge+"|$)"))&&s(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=I.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function T(e,n,r){return v(n)?ce.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?ce.grep(e,function(e){return e===n!==r}):"string"!=typeof n?ce.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(ce.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||k,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:S.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof ce?t[0]:t,ce.merge(this,ce.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:C,!0)),w.test(r[1])&&ce.isPlainObject(t))for(r in t)v(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=C.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):v(e)?void 0!==n.ready?n.ready(e):e(ce):ce.makeArray(e,this)}).prototype=ce.fn,k=ce(C);var E=/^(?:parents|prev(?:Until|All))/,j={children:!0,contents:!0,next:!0,prev:!0};function A(e,t){while((e=e[t])&&1!==e.nodeType);return e}ce.fn.extend({has:function(e){var t=ce(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,Ce=/^$|^module$|\/(?:java|ecma)script/i;xe=C.createDocumentFragment().appendChild(C.createElement("div")),(be=C.createElement("input")).setAttribute("type","radio"),be.setAttribute("checked","checked"),be.setAttribute("name","t"),xe.appendChild(be),le.checkClone=xe.cloneNode(!0).cloneNode(!0).lastChild.checked,xe.innerHTML="",le.noCloneChecked=!!xe.cloneNode(!0).lastChild.defaultValue,xe.innerHTML="",le.option=!!xe.lastChild;var ke={thead:[1,"","
        "],col:[2,"","
        "],tr:[2,"","
        "],td:[3,"","
        "],_default:[0,"",""]};function Se(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&fe(e,t)?ce.merge([e],n):n}function Ee(e,t){for(var n=0,r=e.length;n",""]);var je=/<|&#?\w+;/;function Ae(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function Me(e,t){return fe(e,"table")&&fe(11!==t.nodeType?t:t.firstChild,"tr")&&ce(e).children("tbody")[0]||e}function Ie(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function We(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Fe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(_.hasData(e)&&(s=_.get(e).events))for(i in _.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),C.head.appendChild(r[0])},abort:function(){i&&i()}}});var Jt,Kt=[],Zt=/(=)\?(?=&|$)|\?\?/;ce.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Kt.pop()||ce.expando+"_"+jt.guid++;return this[e]=!0,e}}),ce.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Zt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Zt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=v(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Zt,"$1"+r):!1!==e.jsonp&&(e.url+=(At.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||ce.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=ie[r],ie[r]=function(){o=arguments},n.always(function(){void 0===i?ce(ie).removeProp(r):ie[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Kt.push(r)),o&&v(i)&&i(o[0]),o=i=void 0}),"script"}),le.createHTMLDocument=((Jt=C.implementation.createHTMLDocument("").body).innerHTML="
        ",2===Jt.childNodes.length),ce.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(le.createHTMLDocument?((r=(t=C.implementation.createHTMLDocument("")).createElement("base")).href=C.location.href,t.head.appendChild(r)):t=C),o=!n&&[],(i=w.exec(e))?[t.createElement(i[1])]:(i=Ae([e],t,o),o&&o.length&&ce(o).remove(),ce.merge([],i.childNodes)));var r,i,o},ce.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(ce.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},ce.expr.pseudos.animated=function(t){return ce.grep(ce.timers,function(e){return t===e.elem}).length},ce.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=ce.css(e,"position"),c=ce(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=ce.css(e,"top"),u=ce.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),v(t)&&(t=t.call(e,n,ce.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},ce.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){ce.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===ce.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===ce.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=ce(e).offset()).top+=ce.css(e,"borderTopWidth",!0),i.left+=ce.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-ce.css(r,"marginTop",!0),left:t.left-i.left-ce.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===ce.css(e,"position"))e=e.offsetParent;return e||J})}}),ce.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;ce.fn[t]=function(e){return R(this,function(e,t,n){var r;if(y(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),ce.each(["top","left"],function(e,n){ce.cssHooks[n]=Ye(le.pixelPosition,function(e,t){if(t)return t=Ge(e,n),_e.test(t)?ce(e).position()[n]+"px":t})}),ce.each({Height:"height",Width:"width"},function(a,s){ce.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){ce.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return R(this,function(e,t,n){var r;return y(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?ce.css(e,t,i):ce.style(e,t,n,i)},s,n?e:void 0,n)}})}),ce.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){ce.fn[t]=function(e){return this.on(t,e)}}),ce.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),ce.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){ce.fn[n]=function(e,t){return 0").prependTo(this),fastData:function(e,t,n){return G(u,e,t,n)}}),e=(u.nTable=this,u.oInit=n,i.push(u),u.api=new U(u),u.oInstance=1===W.length?W:o.dataTable(),ne(n),n.aLengthMenu&&!n.iDisplayLength&&(n.iDisplayLength=Array.isArray(n.aLengthMenu[0])?n.aLengthMenu[0][0]:B.isPlainObject(n.aLengthMenu[0])?n.aLengthMenu[0].value:n.aLengthMenu[0]),n=Ge(B.extend(!0,{},t),n),Q(u.oFeatures,n,["bPaginate","bLengthChange","bFilter","bSort","bSortMulti","bInfo","bProcessing","bAutoWidth","bSortClasses","bServerSide","bDeferRender"]),Q(u,n,["ajax","fnFormatNumber","sServerMethod","aaSorting","aaSortingFixed","aLengthMenu","sPaginationType","iStateDuration","bSortCellsTop","iTabIndex","sDom","fnStateLoadCallback","fnStateSaveCallback","renderer","searchDelay","rowId","caption","layout",["iCookieDuration","iStateDuration"],["oSearch","oPreviousSearch"],["aoSearchCols","aoPreSearchCols"],["iDisplayLength","_iDisplayLength"]]),Q(u.oScroll,n,[["sScrollX","sX"],["sScrollXInner","sXInner"],["sScrollY","sY"],["bScrollCollapse","bCollapse"]]),Q(u.oLanguage,n,"fnInfoCallback"),K(u,"aoDrawCallback",n.fnDrawCallback),K(u,"aoStateSaveParams",n.fnStateSaveParams),K(u,"aoStateLoadParams",n.fnStateLoadParams),K(u,"aoStateLoaded",n.fnStateLoaded),K(u,"aoRowCallback",n.fnRowCallback),K(u,"aoRowCreatedCallback",n.fnCreatedRow),K(u,"aoHeaderCallback",n.fnHeaderCallback),K(u,"aoFooterCallback",n.fnFooterCallback),K(u,"aoInitComplete",n.fnInitComplete),K(u,"aoPreDrawCallback",n.fnPreDrawCallback),u.rowIdFn=J(n.rowId),u),c=($.__browser||(P={},$.__browser=P,j=B("
        ").css({position:"fixed",top:0,left:-1*q.pageXOffset,height:1,width:1,overflow:"hidden"}).append(B("
        ").css({position:"absolute",top:1,left:1,width:100,overflow:"scroll"}).append(B("
        ").css({width:"100%",height:10}))).appendTo("body"),p=j.children(),O=p.children(),P.barWidth=p[0].offsetWidth-p[0].clientWidth,P.bScrollbarLeft=1!==Math.round(O.offset().left),j.remove()),B.extend(e.oBrowser,$.__browser),e.oScroll.iBarWidth=$.__browser.barWidth,u.oClasses),d=(B.extend(c,$.ext.classes,n.oClasses),o.addClass(c.table),u.oFeatures.bPaginate||(n.iDisplayStart=0),void 0===u.iInitDisplayStart&&(u.iInitDisplayStart=n.iDisplayStart,u._iDisplayStart=n.iDisplayStart),u.oLanguage),f=(B.extend(!0,d,n.oLanguage),d.sUrl?(B.ajax({dataType:"json",url:d.sUrl,success:function(e){z(t.oLanguage,e),B.extend(!0,d,e,u.oInit.oLanguage),ee(u,null,"i18n",[u],!0),Oe(u)},error:function(){Z(u,0,"i18n file loading error",21),Oe(u)}}),r=!0):ee(u,null,"i18n",[u]),[]),h=this.getElementsByTagName("thead"),p=Ce(u,h[0]);if(n.aoColumns)f=n.aoColumns;else if(p.length)for(l=p[a=0].length;a").appendTo(o):t).html(u.caption),t.length&&(t[0]._captionSide=t.css("caption-side"),u.captionNode=t[0]),0===h.length&&(h=B("").appendTo(o)),u.nTHead=h[0],B("tr",h).addClass(c.thead.row),o.children("tbody")),t=(0===t.length&&(t=B("").insertAfter(h)),u.nTBody=t[0],o.children("tfoot"));if(0===t.length&&(t=B("").appendTo(o)),u.nTFoot=t[0],B("tr",t).addClass(c.tfoot.row),n.aaData)for(a=0;a/g,L=/^\d{2,4}[./-]\d{1,2}[./-]\d{1,2}([T ]{1}\d{1,2}[:.]\d{2}([.:]\d{2})?)?$/,N=new RegExp("(\\"+["/",".","*","+","?","|","(",")","[","]","{","}","\\","$","^","-"].join("|\\")+")","g"),j=/['\u00A0,$ยฃโ‚ฌยฅ%\u2009\u202F\u20BD\u20a9\u20BArfkษƒฮž]/gi,y=function(e){return!e||!0===e||"-"===e},P=function(e,t){return c[t]||(c[t]=new RegExp(je(t),"g")),"string"==typeof e&&"."!==t?e.replace(/\./g,"").replace(c[t],"."):e},f=function(e,t,n){var a=[],r=0,o=e.length;if(void 0!==n)for(;r/g,">").replace(/"/g,"""):e},R=function(e,t){var n;return"string"!=typeof e?e:(n=e.normalize("NFD")).length!==e.length?(!0===t?e+" ":"")+n.replace(/[\u0300-\u036f]/g,""):n},x=function(e){if(Array.from&&Set)return Array.from(new Set(e));if(function(e){if(!(e.length<2))for(var t=e.slice().sort(),n=t[0],a=1,r=t.length;a")}),t=(e.aoColumns.push(t),e.aoPreSearchCols);t[n]=B.extend({},$.models.oSearch,t[n])}function oe(e,t,n){function a(e){return"string"==typeof e&&-1!==e.indexOf("@")}var r=e.aoColumns[t],o=(null!=n&&(ae(n),z($.defaults.column,n,!0),void 0===n.mDataProp||n.mData||(n.mData=n.mDataProp),n.sType&&(r._sManualType=n.sType),n.className&&!n.sClass&&(n.sClass=n.className),t=r.sClass,B.extend(r,n),Q(r,n,"sWidth","sWidthOrig"),t!==r.sClass&&(r.sClass=t+" "+r.sClass),void 0!==n.iDataSort&&(r.aDataSort=[n.iDataSort]),Q(r,n,"aDataSort")),r.mData),i=J(o);r.mRender&&Array.isArray(r.mRender)&&(n=(t=r.mRender.slice()).shift(),r.mRender=$.render[n].apply(q,t)),r._render=r.mRender?J(r.mRender):null;r._bAttrSrc=B.isPlainObject(o)&&(a(o.sort)||a(o.type)||a(o.filter)),r._setter=null,r.fnGetData=function(e,t,n){var a=i(e,t,void 0,n);return r._render&&t?r._render(a,t,e,n):a},r.fnSetData=function(e,t,n){return m(o)(e,t,n)},"number"==typeof o||r._isArrayHost||(e._rowReadObject=!0),e.oFeatures.bSort||(r.bSortable=!1)}function E(e){var t=e;if(t.oFeatures.bAutoWidth){var n,a,r=t.nTable,o=t.aoColumns,i=t.oScroll,l=i.sY,s=i.sX,i=i.sXInner,u=W(t,"bVisible"),c=r.getAttribute("width"),d=r.parentNode,f=r.style.width,f=(f&&-1!==f.indexOf("%")&&(c=f),ee(t,null,"column-calc",{visible:u},!1),B(r.cloneNode()).css("visibility","hidden").removeAttr("id")),h=(f.append(""),B("").appendTo(f.find("tbody")));for(f.append(B(t.nTHead).clone()).append(B(t.nTFoot).clone()),f.find("tfoot th, tfoot td").css("width",""),f.find("thead th, thead td").each(function(){var e=ie(t,this,!0,!1);e?(this.style.width=e,s&&B(this).append(B("
        ").css({width:e,margin:0,padding:0,border:0,height:1}))):this.style.width=""}),n=0;no&&(r=s,o=a.length)}n.maxLenString=r}return n.maxLenString}(t,p),g=C.type.className[a.sType],m=p+a.sContentPadding,p=-1===p.indexOf("<")?_.createTextNode(m):m;B("").addClass(g).addClass(a.sClass).append(p).appendTo(h)}B("[name]",f).removeAttr("name");var v=B("
        ").css(s||l?{position:"absolute",top:0,left:0,height:1,right:0,overflow:"hidden"}:{}).append(f).appendTo(d),b=(s&&i?f.width(i):s?(f.css("width","auto"),f.removeAttr("width"),f.width()").appendTo(o)).length)for(var l=B("td, th",n).length,s=r.length;l").html(r[l][i]||"").appendTo(n);var u=Ce(e,o,!0);"header"===t?e.aoHeader=u:e.aoFooter=u,B(o).children("tr").attr("role","row"),B(o).children("tr").children("th, td").each(function(){Qe(e,t)(e,B(this),a)})}}function De(e,t,n){var a,r,o,i,l,s=[],u=[],c=e.aoColumns,e=c.length;if(t){for(n=n||h(e).filter(function(e){return c[e].bVisible}),a=0;a=s.fnRecordsDisplay()?0:i,s.iInitDisplayStart=-1),-1!==ee(e,"aoPreDrawCallback","preDraw",[e]).indexOf(!1))w(e,!1);else{var l,n=[],a=0,r="ssp"==te(e),o=e.aiDisplay,i=e._iDisplayStart,s=e.fnDisplayEnd(),u=e.aoColumns,c=B(e.nTBody);if(e.bDrawing=!0,r){if(!e.bDestroying&&!t)return 0===e.iDraw&&c.empty().append(Se(e)),(l=e).iDraw++,w(l,!0),void Ie(l,function(t){function n(e,t){return"function"==typeof a[e][t]?"function":a[e][t]}var a=t.aoColumns,e=t.oFeatures,r=t.oPreviousSearch,o=t.aoPreSearchCols;return{draw:t.iDraw,columns:a.map(function(t,e){return{data:n(e,"mData"),name:t.sName,searchable:t.bSearchable,orderable:t.bSortable,search:{value:o[e].search,regex:o[e].regex,fixed:Object.keys(t.searchFixed).map(function(e){return{name:e,term:t.searchFixed[e].toString()}})}}}),order:qe(t).map(function(e){return{column:e.col,dir:e.dir,name:n(e.col,"sName")}}),start:t._iDisplayStart,length:e.bPaginate?t._iDisplayLength:-1,search:{value:r.search,regex:r.regex,fixed:Object.keys(t.searchFixed).map(function(e){return{name:e,term:t.searchFixed[e].toString()}})}}}(l),function(e){var t=l,n=Ae(t,e=e),a=Fe(t,"draw",e),r=Fe(t,"recordsTotal",e),e=Fe(t,"recordsFiltered",e);if(void 0!==a){if(+a").append(B("",{colSpan:H(e),class:e.oClasses.empty.row}).html(n))[0]}function Te(e,t,n){for(var i={},a=(B.each(t,function(e,t){if(null!==t){var e=e.replace(/([A-Z])/g," $1").split(" "),n=(i[e[0]]||(i[e[0]]={}),1===e.length?"full":e[1].toLowerCase()),a=i[e[0]],r=function(t,n){B.isPlainObject(n)?Object.keys(n).map(function(e){t.push({feature:e,opts:n[e]})}):t.push(n)};if(a[n]&&a[n].contents||(a[n]={contents:[]}),Array.isArray(t))for(var o=0;o").attr({id:t.sTableId+"_wrapper",class:e.container}).insertBefore(n),e=(t.nTableWrapper=r[0],Te(t,t.layout,"top")),n=Te(t,t.layout,"bottom"),o=Qe(t,"layout");if(t.sDom)for(var i,l,s,u,c,d,f=t,h=t.sDom,p=r,g=h.match(/(".*?")|('.*?')|./g),m=0;m"),"'"!=(u=g[m+1])[0]&&'"'!=u[0]||(u=u.replace(/['"]/g,""),c="",-1!=u.indexOf(".")?(d=u.split("."),c=d[0],d=d[1]):"#"==u[0]?c=u:d=u,s.attr("id",c.substring(1)).addClass(d),m++),p.append(s),p=s):">"==l?p=p.parent():"t"==l?i=He(f):$.ext.feature.forEach(function(e){l==e.cFeature&&(i=e.fnInit(f))}),i&&p.append(i);else e.forEach(function(e){o(t,r,e)}),o(t,r,{full:{table:!0,contents:[He(t)]}}),n.forEach(function(e){o(t,r,e)});h=t,e=h.nTable;h.oFeatures.bProcessing&&(a=B("
        ",{id:h.sTableId+"_processing",class:h.oClasses.processing.container,role:"status"}).html(h.oLanguage.sProcessing).append("
        ").insertBefore(e),B(e).on("processing.dt.DT",function(e,t,n){a.css("display",n?"block":"none")}))}function Ce(e,t,n){for(var a,r,o,i,l,s,u=e.aoColumns,c=B(t).children("tr"),d=t&&"thead"===t.nodeName.toLowerCase(),f=[],h=0,p=c.length;h/g,""),g.autoTitle=!0)):g.footer&&(r.innerHTML=g.footer),g.ariaTitle||(g.ariaTitle=B(r).attr("aria-label")||g.sTitle),g.className)&&B(r).addClass(g.className),0===B("span.dt-column-title",r).length&&B("").addClass("dt-column-title").append(r.childNodes).appendTo(r),d)&&0===B("span.dt-column-order",r).length&&B("").addClass("dt-column-order").appendTo(r),i=0;i")[0],Re=void 0!==Pe.textContent;function Oe(n){var a,e,t,r,o,i,l=n.iInitDisplayStart;n.bInitialised?(ye(n,"header"),ye(n,"footer"),xe(n,n.aoHeader),xe(n,n.aoFooter),_e(n),t=(e=n).nTHead,i=t.querySelectorAll("tr"),r=e.bSortCellsTop,o=':not([data-dt-order="disable"]):not([data-dt-order="icon-only"])',!0===r?t=i[0]:!1===r&&(t=i[i.length-1]),Ve(e,t,t===e.nTHead?"tr"+o+" th"+o+", tr"+o+" td"+o:"th"+o+", td"+o),Be(e,r=[],e.aaSorting),e.aaSorting=r,Xe(n),w(n,!0),ee(n,null,"preInit",[n],!0),s(n),"ssp"!=(i=te(n))&&("ajax"==i?Ie(n,{},function(e){var t=Ae(n,e);for(a=0;a",{class:a.container}).append(B(s,{class:a.header.self}).css({overflow:"hidden",position:"relative",border:0,width:t?c(t):"100%"}).append(B(s,{class:a.header.inner}).css({"box-sizing":"content-box",width:g.sXInner||"100%"}).append(u.removeAttr("id").css("margin-left",0).append("top"===o?r:null).append(p.children("thead"))))).append(B(s,{class:a.body}).css({position:"relative",overflow:"auto",width:c(t)}).append(p)),l&&u.append(B(s,{class:a.footer.self}).css({overflow:"hidden",border:0,width:t?c(t):"100%"}).append(B(s,{class:a.footer.inner}).append(i.removeAttr("id").css("margin-left",0).append("bottom"===o?r:null).append(p.children("tfoot"))))),c=u.children(),d=c[0],f=c[1],h=l?c[2]:null,B(f).on("scroll.DT",function(){var e=this.scrollLeft;d.scrollLeft=e,l&&(h.scrollLeft=e)}),B("th, td",d).on("focus",function(){var e=d.scrollLeft;f.scrollLeft=e,l&&(f.scrollLeft=e)}),B(f).css("max-height",n),g.bCollapse||B(f).css("height",n),e.nScrollHead=d,e.nScrollBody=f,e.nScrollFoot=h,e.aoDrawCallback.push(We),u[0])}function We(e){var t,n,a=e.oScroll.iBarWidth,r=B(e.nScrollHead).children("div"),o=r.children("table"),i=e.nScrollBody,l=B(i),s=B(e.nScrollFoot).children("div"),u=s.children("table"),c=B(e.nTHead),d=B(e.nTable),f=e.nTFoot&&B("th, td",e.nTFoot).length?B(e.nTFoot):null,h=e.oBrowser,p=i.scrollHeight>i.clientHeight;e.scrollBarVis!==p&&void 0!==e.scrollBarVis?(e.scrollBarVis=p,E(e)):(e.scrollBarVis=p,d.children("thead, tfoot").remove(),(p=c.clone().prependTo(d)).find("th, td").removeAttr("tabindex"),p.find("[id]").removeAttr("id"),f&&(n=f.clone().prependTo(d)).find("[id]").removeAttr("id"),e.aiDisplay.length&&(t=d.find("tbody tr").eq(0).find("th, td").map(function(){return B(this).outerWidth()}),B("col",e.colgroup).each(function(e){this.style.width.replace("px","")!==t[e]&&(this.style.width=t[e]+"px")})),o.find("colgroup").remove(),o.append(e.colgroup.clone()),f&&(u.find("colgroup").remove(),u.append(e.colgroup.clone())),B("th, td",p).each(function(){B(this.childNodes).wrapAll('
        ')}),f&&B("th, td",n).each(function(){B(this.childNodes).wrapAll('
        ')}),c=Math.floor(d.height())>i.clientHeight||"scroll"==l.css("overflow-y"),p="padding"+(h.bScrollbarLeft?"Left":"Right"),n=d.outerWidth(),o.css("width",A(n)),r.css("width",A(n)).css(p,c?a+"px":"0px"),f&&(u.css("width",A(n)),s.css("width",A(n)).css(p,c?a+"px":"0px")),d.children("colgroup").prependTo(d),l.trigger("scroll"),!e.bSorted&&!e.bFiltered||e._drawHold||(i.scrollTop=0))}function A(e){return null===e?"0px":"number"==typeof e?e<0?"0px":e+"px":e.match(/\d$/)?e+"px":e}function Xe(e){var t=e.aoColumns;for(e.colgroup.empty(),a=0;a=o.length?[0,t[1]]:t)})),void 0!==e.search&&B.extend(n.oPreviousSearch,e.search),e.columns){for(a=0,r=e.columns.length;ae?new U(t[e],this[e]):null},filter:function(e){e=n.filter.call(this,e,this);return new U(this.context,e)},flatten:function(){var e=[];return new U(this.context,e.concat.apply(e,this.toArray()))},get:function(e){return this[e]},join:n.join,includes:function(e){return-1!==this.indexOf(e)},indexOf:n.indexOf,iterator:function(e,t,n,a){var r,o,i,l,s,u,c,d,f=[],h=this.context,p=this.selector;for("string"==typeof e&&(a=n,n=t,t=e,e=!1),o=0,i=h.length;o").html(r),e.captionNode=n[0],o)||(t.prepend(n),o=n.css("caption-side")),n.html(r),o&&(n.css("caption-side",o),n[0]._captionSide=o),(a.find("div.dataTables_scroll").length?(e="top"===o?"Head":"Foot",a.find("div.dataTables_scroll"+e+" table")):t).prepend(n)},1)}),t("caption.node()",function(){var e=this.context;return e.length?e[0].captionNode:null}),t("draw()",function(t){return this.iterator("table",function(e){"page"===t?S(e):s(e,!1===(t="string"==typeof t?"full-hold"!==t:t))})}),t("page()",function(t){return void 0===t?this.page.info().page:this.iterator("table",function(e){Me(e,t)})}),t("page.info()",function(){var e,t,n,a,r;if(0!==this.context.length)return t=(e=this.context[0])._iDisplayStart,n=e.oFeatures.bPaginate?e._iDisplayLength:-1,a=e.fnRecordsDisplay(),{page:(r=-1===n)?0:Math.floor(t/n),pages:r?1:Math.ceil(a/n),start:t,end:e.fnDisplayEnd(),length:n,recordsTotal:e.fnRecordsTotal(),recordsDisplay:a,serverSide:"ssp"===te(e)}}),t("page.len()",function(t){return void 0===t?0!==this.context.length?this.context[0]._iDisplayLength:void 0:this.iterator("table",function(e){Ee(e,t)})}),t("ajax.json()",function(){var e=this.context;if(0").attr("data-dt-row",i.idx).addClass(t),B("td",n).addClass(t).html(e)[0].colSpan=H(o),s.push(n[0]))}var s=[];l(e,t),i._details&&i._details.detach(),i._details=B(s),i._detailsShow&&i._details.insertAfter(i.nTr)}function lt(e,t){var n=e.context;if(n.length&&e.length){var a=n[0].aoData[e[0]];if(a._details){(a._detailsShow=t)?(a._details.insertAfter(a.nTr),B(a.nTr).addClass("dt-hasChild")):(a._details.detach(),B(a.nTr).removeClass("dt-hasChild")),ee(n[0],null,"childRow",[t,e.row(e[0])]);var i=n[0],r=new U(i),a=".dt.DT_details",t="draw"+a,e="column-sizing"+a,a="destroy"+a,l=i.aoData;if(r.off(t+" "+e+" "+a),f(l,"_details").length>0){r.on(t,function(e,t){if(i!==t)return;r.rows({page:"current"}).eq(0).each(function(e){var t=l[e];if(t._detailsShow)t._details.insertAfter(t.nTr)})});r.on(e,function(e,t){if(i!==t)return;var n,a=H(t);for(var r=0,o=l.length;r").html(""+Array(e).join("")+""),n=(B(this.table().body()).append(e),e.children().map(function(){return B(this).outerWidth()}));return e.remove(),this.iterator("column",function(e,t){e=T(e,t);return null!==e?n[e]:0},1)}),e("columns().indexes()","column().index()",function(n){return this.iterator("column",function(e,t){return"visible"===n?T(e,t):t},1)}),t("columns.adjust()",function(){return this.iterator("table",function(e){E(e)},1)}),t("column.index()",function(e,t){var n;if(0!==this.context.length)return n=this.context[0],"fromVisible"===e||"toData"===e?M(n,t):"fromData"===e||"toVisible"===e?T(n,t):void 0}),t("column()",function(e,t){return ot(this.columns(e,t))}),t("cells()",function(g,e,m){var a,r,o,i,l,s,t;return B.isPlainObject(g)&&(void 0===g.row?(m=g,g=null):(m=e,e=null)),B.isPlainObject(e)&&(m=e,e=null),null==e?this.iterator("table",function(e){return a=e,e=g,t=rt(m),d=a.aoData,f=ct(a,t),n=b(v(d,f,"anCells")),h=B(O([],n)),p=a.aoColumns.length,at("cell",e,function(e){var t,n="function"==typeof e;if(null==e||n){for(o=[],i=0,l=f.length;i').html(n)[0]:B("

        Examples of MarkBind Websites

        Course Websites

        Online Books

        Product/Project Websites

        @@ -23,50 +23,6 @@ - - - - - - - - diff --git a/showcase.page-vue-render.js b/showcase.page-vue-render.js index 1ccd2e99..5c50ea4b 100644 --- a/showcase.page-vue-render.js +++ b/showcase.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"examples-of-markbind-websites"}},[_v("Examples of MarkBind Websites"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#examples-of-markbind-websites","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h2',{attrs:{"id":"course-websites"}},[_v("Course Websites"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#course-websites","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_c('a',{attrs:{"href":"https://www.comp.nus.edu.sg/~cs2103"}},[_c('strong',[_v("CS2103/T Software Engineering")])])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://www.comp.nus.edu.sg/~cs2113"}},[_c('strong',[_v("CS2113/T Software Engineering and OOP")])])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://nus-cs3281.github.io/website/"}},[_c('strong',[_v("CS3281&2 Thematic Systems Project")])])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://nus-tic2002-2019.github.io/website/"}},[_c('strong',[_v("TIC2002 Introduction to Software Engineering")])])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://nus-te3201.github.io/2020/"}},[_c('strong',[_v("TE3201 Software Engineering")])])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://nus-cs3203.github.io/course-website/"}},[_c('strong',[_v("CS3203 Software Engineering Project")])])])]),_v(" "),_c('h2',{attrs:{"id":"online-books"}},[_v("Online Books"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#online-books","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_c('a',{attrs:{"href":"https://se-education.org/se-book/"}},[_c('strong',[_v("Software Engineering for Self-Directed Learners")])])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://se-education.org/learningresources/"}},[_c('strong',[_v("A Student's Guide to Software Engineering Tools & Techniques")])])])]),_v(" "),_c('h2',{attrs:{"id":"product-project-websites"}},[_v("Product/Project Websites"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#product-project-websites","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_v("This website "),_c('span',{staticClass:"dimmed"},[_v("(i.e., MarkBind website)")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://reposense.org"}},[_c('strong',[_v("reposense.org")])])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://se-education.org"}},[_c('strong',[_v("se-education.org")])])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://damithc.github.io/ab3-markbind/index.html"}},[_c('strong',[_v("AddressBook Level-3")])])])])])} },function anonymous( ) { -with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Thu, 2 May 2024, 14:00:54 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} +with(this){return _c('div',[_c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("[Generated by "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.2")]),_v(" on Wed, 8 May 2024, 6:11:47 UTC]")]),_c('br'),_v(" "),_c('small',[_v("This site is powered by "),_c('a',{attrs:{"href":"https://www.netlify.com/"}},[_v("Netlify")]),_v(".")])])])])} }]; \ No newline at end of file diff --git a/userGuide/deployingTheSite._include_.html b/userGuide/deployingTheSite._include_.html index a6f569d2..723a9253 100644 --- a/userGuide/deployingTheSite._include_.html +++ b/userGuide/deployingTheSite._include_.html @@ -79,26 +79,7 @@

        Using CI Platformsnode-version: '16' - run: npm i -g markbind-cli - run: markbind deploy --ci -