Skip to content

Update default template with UG links and useful information #2225

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
lhw-1 merged 22 commits into from
Apr 2, 2023
Merged

Update default template with UG links and useful information #2225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
728d541
Modify default template, prototype
lhw-1 Mar 18, 2023
2e0be1f
Modify wording in templates.md
lhw-1 Mar 18, 2023
e5fe958
Merge branch 'master' into 2214-update-default-template
lhw-1 Mar 19, 2023
d5317d0
Change headings to markdown
lhw-1 Mar 20, 2023
b63d331
Update packages/core/template/default/index.md
lhw-1 Mar 20, 2023
8e83dbc
Update tests
lhw-1 Mar 20, 2023
44f4454
Make changes
lhw-1 Mar 20, 2023
cc92d45
Update tests
lhw-1 Mar 20, 2023
8e9f2a7
Merge branch 'master' into 2214-update-default-template
lhw-1 Mar 22, 2023
1518b86
Merge branch 'master' into 2214-update-default-template
lhw-1 Mar 26, 2023
00d8a87
Update template
lhw-1 Mar 26, 2023
44448c5
Merge branch 'master' into 2214-update-default-template
lhw-1 Mar 27, 2023
bd492c6
Merge branch 'master' into 2214-update-default-template
lhw-1 Mar 28, 2023
945ea73
Fix nits
lhw-1 Mar 28, 2023
579dc10
Update tests
lhw-1 Mar 28, 2023
8263e81
Merge branch 'master' into 2214-update-default-template
lhw-1 Mar 29, 2023
fab85db
Fix more nits
lhw-1 Mar 29, 2023
eface18
Fix even more nits
lhw-1 Mar 29, 2023
9d241cb
Merge branch 'master' into 2214-update-default-template
lhw-1 Mar 30, 2023
7d8d0be
Merge branch 'master' into 2214-update-default-template
lhw-1 Mar 31, 2023
83322a0
Merge branch 'master' into 2214-update-default-template
lhw-1 Apr 2, 2023
4ba5a92
Resolve merge conflicts
lhw-1 Apr 2, 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
4 changes: 2 additions & 2 deletions docs/userGuide/templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ markbind init --template minimal

Name | Template key | Description | Quick Deploy
---- | ------- | ----------- | ------------
Default | `default` | Default template if `--template` is unspecified. Filled with MarkBind features to guide you to author better content. | <a href="https://app.netlify.com/start/deploy?repository=https://github.com/MarkBind/init-typical-netlify"><img src="https://www.netlify.com/img/deploy/button.svg" /></a>
Minimal | `minimal` | Minimalistic template that gets you started quickly | <a href="https://app.netlify.com/start/deploy?repository=https://github.com/MarkBind/init-minimal-netlify"><img src="https://www.netlify.com/img/deploy/button.svg" /></a>
Default | `default` | Default template if `--template` is unspecified. Includes core features such as site and page navigation for a more convenient quick start. | <a href="https://app.netlify.com/start/deploy?repository=https://github.com/MarkBind/init-typical-netlify"><img src="https://www.netlify.com/img/deploy/button.svg" /></a>
Minimal | `minimal` | Minimalistic template that gets you started quickly. | <a href="https://app.netlify.com/start/deploy?repository=https://github.com/MarkBind/init-minimal-netlify"><img src="https://www.netlify.com/img/deploy/button.svg" /></a>
189 changes: 42 additions & 147 deletions packages/cli/test/functional/test_site_templates/test_default/expected/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="MarkBind 4.1.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Landing Page</title>
<title>Home Page</title>
<link rel="stylesheet" href="/markbind/css/bootstrap.min.css">
<link rel="stylesheet" href="/markbind/fontawesome/css/all.min.css">
<link rel="stylesheet" href="/markbind/glyphicons/css/bootstrap-glyphicons.min.css">
Expand Down Expand Up @@ -89,164 +89,59 @@
<breadcrumb></breadcrumb>

<br>
<div class="bg-primary text-white py-5 mb-4">
<div class="bg-primary text-white px-2 py-5 mb-4">
<div class="container">
<h1 class="display-4 no-index" id="landing-page-title">Landing Page Title<a class="fa fa-anchor" href="#landing-page-title" onclick="event.stopPropagation()"></a></h1>
<p class="lead">A tagline can go here</p>
<h1 class="display-5 no-index" id="great-you-ve-just-initialized-a-markbind-site">Great!<br>You've just initialized a MarkBind site.<a class="fa fa-anchor" href="#great-you-ve-just-initialized-a-markbind-site" onclick="event.stopPropagation()"></a></h1>
<p class="lead">Let's get started...</p>
</div>
</div>
<h1 id="heading-1">Heading 1<a class="fa fa-anchor" href="#heading-1" onclick="event.stopPropagation()"></a></h1>
<p>Some text some text some text some text some text some text some text. <strong>Some text some text some text some text some text <mark>some text</mark> some text</strong>. Some text some text some text some text some text some text some text some text some text some text some text some text some text some text. Some text some text some text some text some text some text. Some text some text some text some text some text some text some text.</p>
<p><strong>A block quote:</strong></p>
<blockquote>
<p>Some text some text some text some text some text some text some text. Some text some text some text some text some text some text some text. Some text some text some text some text some text some text some text some text some text some text some text some text some text some text. Some text some text some text some text some text some text. Some text some text some text some text some text some text some text.</p>
</blockquote>
<p><strong>A list:</strong></p>
<ul>
<li>item A</li>
<li>item B
<ol>
<li>item b1</li>
<li>item b2</li>
<li>item b3</li>
</ol>
</li>
</ul>
<p><strong>A <code class="hljs inline no-lang" v-pre>code</code> example:</strong></p>
<pre><code class="hljs html" v-pre><span><span class="hljs-tag">&lt;<span class="hljs-name">foo</span>&gt;</span>
</span><span> <span class="hljs-tag">&lt;<span class="hljs-name">bar</span> <span class="hljs-attr">type</span>=<span class="hljs-string">&quot;name&quot;</span>&gt;</span>goo<span class="hljs-tag">&lt;/<span class="hljs-name">bar</span>&gt;</span>
</span><span><span class="hljs-tag">&lt;/<span class="hljs-name">foo</span>&gt;</span>
</span></code></pre>
<h2 id="sub-heading-1-1">Sub Heading 1.1<a class="fa fa-anchor" href="#sub-heading-1-1" onclick="event.stopPropagation()"></a></h2>
<p>A <tooltip placement="top" trigger="hover"><template #content>❗️ some <strong>important explanation</strong></template>tooltip</tooltip>, a <trigger for="modal:modalinfo" trigger="click">modal</trigger>, a <a href="https://markbind.org/">link</a>, a <span class="badge bg-danger">badge</span>, another <span class="badge bg-warning text-dark">badge</span>.</p>
<modal id="modal:modalinfo"><template #header>Modal Title</template>
Some text some text some text some text some text some text some text. Some text some text some text some text some text some text some text. Some text some text some text some text some text some text some text some text some text some text some text some text some text some text. Some text some text some text some text some text some text. Some text some text some text some text some text some text some text.
</modal>
<p><strong>A table:</strong></p>
<div class="table-responsive">
<table class="markbind-table table table-bordered table-striped">
<thead>
<tr>
<th style="text-align:center">Column 1</th>
<th style="text-align:center">Column 2</th>
<th style="text-align:center">Column 3</th>
<th><span aria-hidden="true" class="far fa-thumbs-up"></span> / <span aria-hidden="true" class="far fa-thumbs-down"></span>?</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center">value1</td>
<td style="text-align:center">x</td>
<td style="text-align:center">5</td>
<td><span aria-hidden="true" class="far fa-thumbs-up"></span></td>
</tr>
<tr>
<td style="text-align:center">value2</td>
<td style="text-align:center">y</td>
<td style="text-align:center">20</td>
<td><span aria-hidden="true" class="far fa-thumbs-down"></span></td>
</tr>
</tbody>
</table>
</div>
<h2 id="sub-heading-1-2">Sub Heading 1.2<a class="fa fa-anchor" href="#sub-heading-1-2" onclick="event.stopPropagation()"></a></h2>
<p><strong>Media embeds:</strong></p>
<div class="block-embed block-embed-service-youtube" style="position: relative; padding-bottom: 60.9375%"><iframe type="text/html" src="//www.youtube.com/embed/v40b3ExbM0c" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe></div>
<p><strong>Tabs:</strong></p>
<tabs>
<tab><template #header>Tab X</template>
Some text some text some text some text some text some text some text. Some text some text some text some text some text some text some text. Some text some text some text some text some text some text some text some text some text some text some text some text some text some text. Some text some text some text some text some text some text. Some text some text some text some text some text some text some text.
</tab>
<tab><template #header>Tab Y</template>
...
</tab>
<tab-group><template #header>Tab group</template>
<tab><template #header>Tab Y.1</template>
...
</tab>
<tab><template #header>Tab Y.2</template>
...
</tab>
</tab-group>
</tabs>
<br>
<h1 id="heading-2">Heading 2<a class="fa fa-anchor" href="#heading-2" onclick="event.stopPropagation()"></a></h1>
<p><strong>Some boxes:</strong></p>
<box>
default
<hr>
<h2 id="what-just-happened">What just happened?<a class="fa fa-anchor" href="#what-just-happened" onclick="event.stopPropagation()"></a></h2>
<p>You have just initialized a <em>default</em> MarkBind site! It is equipped with a set of core features, including site and page navigation. Additionally, we have included some convenient links to our User Guide, to help you get started quickly and easily.</p>
<box type="tip">
<p>If you were intending to convert an existing GitHub wiki or a docs folder into MarkBind, use the <code class="hljs inline no-lang" v-pre>--convert</code> flag instead. See <a href="https://markbind.org/userGuide/markBindInTheProjectWorkflow.html#converting-existing-project-documentation-wiki" target="_blank">User Guide: MarkBind in the Project Workflow</a> for more information.</p>
<p>If you want to start with a <tooltip><template #content>i.e. without any content</template><em>minimal</em></tooltip> template instead, use the <code class="hljs inline no-lang" v-pre>--template</code> flag with the &quot;minimal&quot; option to initialize a minimal site instead of the default. See <a href="https://markbind.org/userGuide/templates.html" target="_blank">User Guide: Templates</a> for more information.</p>
</box>
<hr>
<h2 id="navigating-this-site">Navigating this site<a class="fa fa-anchor" href="#navigating-this-site" onclick="event.stopPropagation()"></a></h2>
<p>This <em>default</em> site comes pre-configured with the core <a href="https://markbind.org/userGuide/components/navigation.html#navigation-components" target="_blank">Navigation components</a>: a <tooltip><template #content>Site Navigation</template><strong>siteNav</strong></tooltip>, a <tooltip><template #content>Page Navigation</template><strong>pageNav</strong></tooltip>, a <tooltip><template #content>Navigation Bar</template><strong>NavBar</strong></tooltip>, and a <strong>Search Bar</strong>. To help you get started with the <strong>siteNav</strong>, we have included <tooltip><template #content>Topic 1, Topic 2, Topic 3, Topic 3a, Topic 3b</template>five dummy placeholder pages</tooltip>. The <strong>NavBar</strong> also comes with a placeholder slot for your custom Logo.</p>
<hr>
<h2 id="guide-to-markbind">Guide to MarkBind<a class="fa fa-anchor" href="#guide-to-markbind" onclick="event.stopPropagation()"></a></h2>
<p>To see the capability of MarkBind in action, feel free to take a look at some of the websites built using MarkBind on our <a href="https://markbind.org/showcase.html" target="_blank">Showcase</a> page.</p>
<p>For more information on how to work with MarkBind sites and to add content, refer to our comprehensive <a href="https://markbind.org/userGuide/gettingStarted.html" target="_blank">User Guide</a>.</p>
<box type="info">
info
</box>
<box type="warning" dismissible>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
</box>
<box type="tip"><template #header>
<p>Box heading</p>
</template>
tip
<p>If you are interested in contributing to MarkBind, you can refer to our <a href="https://markbind.org/devdocs/devGuide/devGuide.html" target="_blank">Developer Guide</a> as well!</p>
</box>
<box type="success"><template #header>
<p>Box heading</p>
</template>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
</box>
<box type="important" dismissible><template #header>
<p>Box heading</p>
</template>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
</box>
<br>
<h1 id="heading-3">Heading 3<a class="fa fa-anchor" href="#heading-3" onclick="event.stopPropagation()"></a></h1>
<panel type="info"><template #header>
<p>Expandable panel</p>
</template>
Some text some text some text some text some text some text some text. Some text some text some text some text some text some text some text. Some text some text some text some text some text some text some text some text some text some text some text some text some text some text. Some text some text some text some text some text some text. Some text some text some text some text some text some text some text.
</panel>
<br>
<panel type="info" expanded><template #header>
<p>Expanded panel on load</p>
</template>
...
</panel>
<br>
<panel type="success" minimized><template #header>
<p>Expanded panel header</p>
</template><template #_alt>
<p>Minimized panel header</p>
</template>
...
</panel>
<br>
<panel type="seamless"><template #header>
<p>Expanded panel header</p>
</template><template #_alt>
<p>Minimized panel header</p>
</template>
...
</panel>
<br>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
<panel type="minimal" popup-url="https://markbind.org/userGuide/components/presentation.html#panels" no-switch><template #header>
<p><em><strong>Minimal panel <strong>-&gt;</strong></strong></em></p>
</template><template #_alt>
<p>Minimal panel</p>
<panel expanded no-close><template #header>
<p><strong>Good starting points in our User Guide</strong></p>
</template>
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
<h5 id="user-guide-authoring-contents"><strong>User Guide: Authoring Contents</strong><a class="fa fa-anchor" href="#user-guide-authoring-contents" onclick="event.stopPropagation()"></a></h5>
<blockquote>
<p>Learn about the variety of syntax schemes, formats, and custom MarkBind components that you can use in your MarkBind site.</p>
</blockquote>
<p>More info in: <em><a href="https://markbind.org/userGuide/authoringContents.html" target="_blank">User Guide → Authoring Contents</a></em></p>
<hr>
<h5 id="user-guide-working-with-sites"><strong>User Guide: Working with Sites</strong><a class="fa fa-anchor" href="#user-guide-working-with-sites" onclick="event.stopPropagation()"></a></h5>
<blockquote>
<p>Learn how to modify site properties, apply themes, and enable/disable plugins for your MarkBind site.</p>
</blockquote>
<p>More info in: <em><a href="https://markbind.org/userGuide/workingWithSites.html" target="_blank">User Guide → Working with Sites</a></em></p>
<hr>
<h5 id="user-guide-full-syntax-reference"><strong>User Guide: Full Syntax Reference</strong><a class="fa fa-anchor" href="#user-guide-full-syntax-reference" onclick="event.stopPropagation()"></a></h5>
<blockquote>
<p>Refer to our Full Syntax Reference page to find a specific feature or component that you want to use in your MarkBind site.</p>
</blockquote>
<p>More info in: <em><a href="https://markbind.org/userGuide/fullSyntaxReference.html" target="_blank">User Guide → Full Syntax Reference</a></em></p>
</panel>
<p>Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
<hr>
</div>
<overlay-source id="page-nav" tag-name="nav" to="page-nav">
<div class="nav-component slim-scroll">
<a class="navbar-brand page-nav-title" href="#" v-pre>Chapters of This Page</a>
<a class="navbar-brand page-nav-title" href="#" v-pre>Topics</a>
<overlay-source id="mb-page-nav" tag-name="nav" to="mb-page-nav" class="nav nav-pills flex-column my-0 small no-flex-wrap">
<a class="nav-link py-1" href="#heading-1" v-pre>Heading 1&#x200E;</a>
<nav class="nav nav-pills flex-column my-0 nested no-flex-wrap">
<a class="nav-link py-1" href="#sub-heading-1-1" v-pre>Sub Heading 1.1&#x200E;</a>
<a class="nav-link py-1" href="#sub-heading-1-2" v-pre>Sub Heading 1.2&#x200E;</a>
</nav>
<a class="nav-link py-1" href="#heading-2" v-pre>Heading 2&#x200E;</a>
<a class="nav-link py-1" href="#heading-3" v-pre>Heading 3&#x200E;</a>
<a class="nav-link py-1" href="#what-just-happened" v-pre>What just happened?&#x200E;</a>
<a class="nav-link py-1" href="#navigating-this-site" v-pre>Navigating this site&#x200E;</a>
<a class="nav-link py-1" href="#guide-to-markbind" v-pre>Guide to MarkBind&#x200E;</a>

</overlay-source>
</div>
Expand Down
Loading