Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Update Site to generate default.md based on template #2308

Closed
wants to merge 13 commits into from
Closed

Update Site to generate default.md based on template #2308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
f95483b
Update siteConvertLayout to clone default.md
WillCWX Jun 12, 2023
4b432a1
Update conversion tests to fit default.md layout
WillCWX Jun 14, 2023
8ce2915
Update functional test
WillCWX Jun 14, 2023
05551ab
Fix spelling mistakes
WillCWX Jun 14, 2023
45d0ead
Combine convert and generateTemplateDefault
WillCWX Jun 19, 2023
b522e26
Merge branch 'master' into 2293-generate-default
WillCWX Jun 19, 2023
154dbc1
Rename generateDefaultLayout to initSite
WillCWX Jun 21, 2023
e593fc9
Merge branch 'master' into 2293-generate-default
WillCWX Jul 9, 2023
2414fb1
Rename NjkVars to NjkFileVars
WillCWX Jul 9, 2023
7795437
Rename variables to make more sense
WillCWX Jul 23, 2023
9f9fb59
Update markbind to v5.0.1
WillCWX Jul 23, 2023
d281142
Merge branch 'master' into 2293-generate-default
WillCWX Jul 23, 2023
0904897
Fix missing minimal layout folder
WillCWX Jul 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 7 additions & 15 deletions packages/cli/src/cmd/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,14 @@ function init(root, options) {

const template = new Template(rootFolder, options.template);
template.init()
.then(() => {
.then((templateConfig) => {
logger.info('Initialization success.');
})
.then(() => {
if (options.convert) {
logger.info('Converting to MarkBind website.');
const outputRoot = path.join(rootFolder, '_site');
new Site(rootFolder, outputRoot).convert()
.then(() => {
logger.info('Conversion success.');
})
.catch((error) => {
logger.error(error.message);
process.exitCode = 1;
});
}
const outputRoot = path.join(rootFolder, '_site');
new Site(rootFolder, outputRoot).initSite(templateConfig, options.convert)
.catch((error) => {
logger.error(`Failed to generate template default with error: ${error.message}`);
process.exitCode = 1;
});
})
.catch((error) => {
logger.error(`Failed to initialize site with given template with error: ${error.message}`);
Expand Down
58 changes: 8 additions & 50 deletions packages/cli/test/functional/test_site_convert/test_basic_convert/expected/404.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,65 +20,23 @@
<script src="404.page-vue-render.js"></script>
<link rel="stylesheet" href="/plugins/markbind-plugin-anchors/markbind-plugin-anchors.css">
<link rel="stylesheet" href="/plugins/markbind-plugin-tree/markbind-plugin-tree.css">

<link rel="stylesheet" href="/stylesheets/main.css">
</head>
<script>
const baseUrl = ''
</script>

<body>
<div id="app">
<header sticky>
<navbar placement="top" type="dark">
<template #brand><a href="/index.html" title="Home" class="navbar-brand">
<i class="far fa-file-image"></i></a></template>
<li><a href="/index.html" class="nav-link">HOME</a></li>
<li><a href="/about.html" class="nav-link">ABOUT</a></li>
<template #right>
<li>
<form class="navbar-form">
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback" menu-align-right></searchbar>
</form>
</li>
</template>
</navbar>
</header>
<div id="flex-body">
<overlay-source id="site-nav" tag-name="nav" to="site-nav">
<div class="site-nav-top">
<div class="fw-bold mb-2" style="font-size: 1.25rem;">Contents</div>
</div>
<div class="nav-component slim-scroll">
<site-nav>
<overlay-source class="site-nav-list site-nav-list-root" tag-name="ul" to="mb-site-nav">
<li class="site-nav-custom-list-item site-nav-list-item-0">[[Home]]</li>
<li class="site-nav-custom-list-item site-nav-list-item-0">[[Page-1]]</li>
</overlay-source>
</site-nav>
</div>
</overlay-source>
<div id="content-wrapper">
<breadcrumb></breadcrumb>

<p>
<div class="text-center">
<p style="font-size: 10rem">404</p>
</div>
<div class="text-center">
<p style="font-size: 1.5rem">File not found<br>Click <a href="/">here</a> to go back to the home page.</p>
</div>
</p>
<div>
<p>
<div class="text-center">
<p style="font-size: 10rem">404</p>
</div>
<div class="text-center">
<p style="font-size: 1.5rem">File not found<br>Click <a href="/">here</a> to go back to the home page.</p>
</div>
<overlay-source id="page-nav" tag-name="nav" to="page-nav">
<div class="nav-component slim-scroll">
</div>
</overlay-source>
<scroll-top-button></scroll-top-button>
</p>
</div>
<footer>
Custom footer.
</footer>
</div>
</body>
<script src="/markbind/js/bootstrap-utility.min.js"></script>
Expand Down
7 changes: 2 additions & 5 deletions .../cli/test/functional/test_site_convert/test_basic_convert/expected/404.page-vue-render.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@

var pageVueRenderFn = function anonymous(
) {
with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"placement":"top","type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('i',{staticClass:"far fa-file-image"})])]},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:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])])])],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("Contents")])]),_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',{staticClass:"site-nav-custom-list-item site-nav-list-item-0"},[_v("[[Home]]")]),_v(" "),_c('li',{staticClass:"site-nav-custom-list-item site-nav-list-item-0"},[_v("[[Page-1]]")])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('breadcrumb'),_v(" "),_c('p'),_m(0),_v(" "),_m(1),_c('p')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"})]),_v(" "),_c('scroll-top-button')],1),_v(" "),_c('footer',[_v("\nCustom footer.\n")])])}
with(this){return _m(0)}
};
var pageVueStaticRenderFns = [function anonymous(
) {
with(this){return _c('div',{staticClass:"text-center"},[_c('p',{staticStyle:{"font-size":"10rem"}},[_v("404")])])}
},function anonymous(
) {
with(this){return _c('div',{staticClass:"text-center"},[_c('p',{staticStyle:{"font-size":"1.5rem"}},[_v("File not found"),_c('br'),_v("Click "),_c('a',{attrs:{"href":"/"}},[_v("here")]),_v(" to go back to the home page.")])])}
with(this){return _c('div',{attrs:{"id":"app"}},[_c('div',[_c('p'),_c('div',{staticClass:"text-center"},[_c('p',{staticStyle:{"font-size":"10rem"}},[_v("404")])]),_v(" "),_c('div',{staticClass:"text-center"},[_c('p',{staticStyle:{"font-size":"1.5rem"}},[_v("File not found"),_c('br'),_v("Click "),_c('a',{attrs:{"href":"/"}},[_v("here")]),_v(" to go back to the home page.")])]),_c('p')])])}
}];

42 changes: 37 additions & 5 deletions packages/cli/test/functional/test_site_convert/test_basic_convert/expected/Home.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,14 @@
<body>
<div id="app">
<header sticky>
<navbar placement="top" type="dark">
<template #brand><a href="/index.html" title="Home" class="navbar-brand">
<i class="far fa-file-image"></i></a></template>
<li><a href="/index.html" class="nav-link">HOME</a></li>
<li><a href="/about.html" class="nav-link">ABOUT</a></li>
<navbar type="dark">
<template #brand><a href="/index.html" title="Home" class="navbar-brand">Your Logo</a></template>
<li><a href="/contents/topic1.html" class="nav-link">Topic 1</a></li>
<li><a href="/contents/topic2.html" class="nav-link">Topic 2</a></li>
<dropdown class="nav-link"><template #header>Topic 3</template>
<li><a href="/contents/topic3a.html" class="dropdown-item">Topic 3a</a></li>
<li><a href="/contents/topic3b.html" class="dropdown-item">Topic 3b</a></li>
</dropdown>
<template #right>
<li>
<form class="navbar-form">
Expand All @@ -51,6 +54,31 @@
<div class="nav-component slim-scroll">
<site-nav>
<overlay-source class="site-nav-list site-nav-list-root" tag-name="ul" to="mb-site-nav">
<li>
<div class="site-nav-default-list-item site-nav-list-item-0" onclick="handleSiteNavClick(this)"><a href="/index.html">Home 🏠</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-0" onclick="handleSiteNavClick(this)"><a href="/contents/topic1.html">Topic 1</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-0" onclick="handleSiteNavClick(this)"><a href="/contents/topic2.html">Topic 2</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-0" onclick="handleSiteNavClick(this)">Topic 3

<div class="site-nav-dropdown-btn-container"><i class="site-nav-dropdown-btn-icon site-nav-rotate-icon" onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();">
<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>
</i></div>
</div>
<ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list">
<li>
<div class="site-nav-default-list-item site-nav-list-item-1" onclick="handleSiteNavClick(this)"><a href="/contents/topic3a.html">Topic 3a</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-1" onclick="handleSiteNavClick(this)"><a href="/contents/topic3b.html">Topic 3b</a></div>
</li>
</ul>
</li>
<li class="site-nav-custom-list-item site-nav-list-item-0">[[Home]]</li>
<li class="site-nav-custom-list-item site-nav-list-item-0">[[Page-1]]</li>
</overlay-source>
Expand All @@ -69,6 +97,10 @@
</div>
<footer>
Custom footer.

<div class="text-center">
<small>[Generated by <a href="https://markbind.org/">MarkBind 5.0.1</a>]</small>
</div>
</footer>
</div>
</body>
Expand Down
7 changes: 5 additions & 2 deletions ...cli/test/functional/test_site_convert/test_basic_convert/expected/Home.page-vue-render.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 37 additions & 5 deletions packages/cli/test/functional/test_site_convert/test_basic_convert/expected/Page-1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,14 @@
<body>
<div id="app">
<header sticky>
<navbar placement="top" type="dark">
<template #brand><a href="/index.html" title="Home" class="navbar-brand">
<i class="far fa-file-image"></i></a></template>
<li><a href="/index.html" class="nav-link">HOME</a></li>
<li><a href="/about.html" class="nav-link">ABOUT</a></li>
<navbar type="dark">
<template #brand><a href="/index.html" title="Home" class="navbar-brand">Your Logo</a></template>
<li><a href="/contents/topic1.html" class="nav-link">Topic 1</a></li>
<li><a href="/contents/topic2.html" class="nav-link">Topic 2</a></li>
<dropdown class="nav-link"><template #header>Topic 3</template>
<li><a href="/contents/topic3a.html" class="dropdown-item">Topic 3a</a></li>
<li><a href="/contents/topic3b.html" class="dropdown-item">Topic 3b</a></li>
</dropdown>
<template #right>
<li>
<form class="navbar-form">
Expand All @@ -51,6 +54,31 @@
<div class="nav-component slim-scroll">
<site-nav>
<overlay-source class="site-nav-list site-nav-list-root" tag-name="ul" to="mb-site-nav">
<li>
<div class="site-nav-default-list-item site-nav-list-item-0" onclick="handleSiteNavClick(this)"><a href="/index.html">Home 🏠</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-0" onclick="handleSiteNavClick(this)"><a href="/contents/topic1.html">Topic 1</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-0" onclick="handleSiteNavClick(this)"><a href="/contents/topic2.html">Topic 2</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-0" onclick="handleSiteNavClick(this)">Topic 3

<div class="site-nav-dropdown-btn-container"><i class="site-nav-dropdown-btn-icon site-nav-rotate-icon" onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();">
<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>
</i></div>
</div>
<ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list">
<li>
<div class="site-nav-default-list-item site-nav-list-item-1" onclick="handleSiteNavClick(this)"><a href="/contents/topic3a.html">Topic 3a</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-1" onclick="handleSiteNavClick(this)"><a href="/contents/topic3b.html">Topic 3b</a></div>
</li>
</ul>
</li>
<li class="site-nav-custom-list-item site-nav-list-item-0">[[Home]]</li>
<li class="site-nav-custom-list-item site-nav-list-item-0">[[Page-1]]</li>
</overlay-source>
Expand All @@ -69,6 +97,10 @@ <h1 id="page-1">Page 1<a class="fa fa-anchor" href="#page-1" onclick="event.stop
</div>
<footer>
Custom footer.

<div class="text-center">
<small>[Generated by <a href="https://markbind.org/">MarkBind 5.0.1</a>]</small>
</div>
</footer>
</div>
</body>
Expand Down
Loading