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.

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

MarkBind Template for Software Project Documentation #2400

Merged
merged 50 commits into from
Mar 30, 2024
Merged
Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
22853a6
Update templates and add ab3 template
KevinEyo1 Jan 27, 2024
e76fb5f
Remove ab3 template folder
KevinEyo1 Jan 27, 2024
e3c1138
Update files
KevinEyo1 Jan 27, 2024
ef96316
Remove unneeded changes
KevinEyo1 Jan 28, 2024
5444909
a
KevinEyo1 Jan 29, 2024
a4a4d72
Revert test changes
KevinEyo1 Jan 29, 2024
ea3aca7
Merge branch 'MarkBind:master' into master
KevinEyo1 Feb 4, 2024
a7f1a81
Replace ab3 with project
KevinEyo1 Feb 4, 2024
d926774
Remove ab3 package
KevinEyo1 Feb 4, 2024
c21eefb
Add project template folder
KevinEyo1 Feb 4, 2024
c0f79a2
Merge branch 'MarkBind:master' into master
KevinEyo1 Feb 9, 2024
c0207fd
Update project template
KevinEyo1 Feb 11, 2024
b6ed49a
Merge branch 'MarkBind:master' into 2384-markbind-template-project
KevinEyo1 Feb 11, 2024
e40a454
Update template file
KevinEyo1 Feb 11, 2024
8fd7b50
Remove unused gemfile.lock
KevinEyo1 Feb 11, 2024
c55e5b9
Merge branch '2384-markbind-template-project' of https://github.com/K…
KevinEyo1 Feb 11, 2024
5ada339
Update contributor list
KevinEyo1 Feb 11, 2024
610e546
Fix indentations
KevinEyo1 Feb 11, 2024
ab51281
Add expected template files for testing
KevinEyo1 Feb 12, 2024
9721e3e
Remove contributor part
KevinEyo1 Feb 16, 2024
47ea93d
Remove traces of ab3
KevinEyo1 Feb 18, 2024
45b8846
Merge branch 'MarkBind:master' into master
KevinEyo1 Feb 18, 2024
a3e5ae2
Merge branch 'MarkBind:master' into 2384-markbind-template-project
KevinEyo1 Feb 18, 2024
fa5c24d
Update tests
KevinEyo1 Feb 18, 2024
21628f7
Merge branch 'MarkBind:master' into master
KevinEyo1 Feb 28, 2024
3c704a8
Merge branch 'MarkBind:master' into 2384-markbind-template-project
KevinEyo1 Feb 28, 2024
b0b9deb
Improve template based on reviews
KevinEyo1 Feb 28, 2024
6c9c3ad
Merge branch '2384-markbind-template-project' of https://github.com/K…
KevinEyo1 Feb 28, 2024
e39a176
Update expected tests
KevinEyo1 Feb 28, 2024
b606951
Merge branch 'master' into 2384-markbind-template-project
KevinEyo1 Mar 7, 2024
0f10968
Update project template
KevinEyo1 Mar 7, 2024
7624b37
Merge branch 'MarkBind:master' into 2384-markbind-template-project
KevinEyo1 Mar 12, 2024
da2cdd8
Update project template docs
KevinEyo1 Mar 12, 2024
21fa90c
Merge branch 'master' of https://github.com/KevinEyo1/markbind
KevinEyo1 Mar 15, 2024
2bcf610
Merge branch 'MarkBind:master' into 2384-markbind-template-project
KevinEyo1 Mar 18, 2024
0ebb7cd
Merge branch 'MarkBind:master' into master
KevinEyo1 Mar 18, 2024
8c88572
Merge branch 'master' into 2384-markbind-template-project
KevinEyo1 Mar 18, 2024
6c17ad7
Merge branch '2384-markbind-template-project' of https://github.com/K…
KevinEyo1 Mar 18, 2024
a120fa3
Fix nits
KevinEyo1 Mar 19, 2024
f798b1d
Merge branch 'master' of https://github.com/MarkBind/markbind
KevinEyo1 Mar 20, 2024
48399bd
Merge branch 'master' of https://github.com/MarkBind/markbind
KevinEyo1 Mar 20, 2024
050620c
Merge branch 'master' into 2384-markbind-template-project
KevinEyo1 Mar 22, 2024
701183b
Merge branch 'master' of https://github.com/MarkBind/markbind
KevinEyo1 Mar 25, 2024
7d8db65
Merge branch 'master' into 2384-markbind-template-project
KevinEyo1 Mar 25, 2024
4a83981
Merge branch 'master' of https://github.com/MarkBind/markbind
KevinEyo1 Mar 29, 2024
7e7cfb7
Merge branch 'master' of https://github.com/MarkBind/markbind
KevinEyo1 Mar 29, 2024
c0d056e
Merge branch 'master' into 2384-markbind-template-project
KevinEyo1 Mar 29, 2024
2da3d63
Merge branch 'master' into 2384-markbind-template-project
KevinEyo1 Mar 30, 2024
7feb0ed
Merge changes
KevinEyo1 Mar 30, 2024
8e45510
Merge branch '2384-markbind-template-project' of https://github.com/K…
KevinEyo1 Mar 30, 2024
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
3 changes: 2 additions & 1 deletion docs/userGuide/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ markbind init --template minimal
Name | Template key | Description | Quick Deploy
---- | ------- | ----------- | ------------
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>
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>
Project | `project` | Project documentation template serves as a good starting point for project developers. This template includes both a user guide and a developer guide, with some formatted dummy content. | <a href="https://markbind-template-project.netlify.app/"><img src="https://www.netlify.com/img/deploy/button.svg" /></a>

{% from "njk/common.njk" import previous_next %}
{{ previous_next('addingNavigationButtons', '') }}
1 change: 1 addition & 0 deletions packages/cli/test/functional/testSites.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const testConvertSites = [
const testTemplateSites = [
'minimal,test_site_templates/test_minimal',
'default,test_site_templates/test_default',
'project,test_site_templates/test_project',
];

// These files will be generated within test_site/expected/
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
<!DOCTYPE html>
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="MarkBind 5.3.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Configuration guide - ProjectEx</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">
<link rel="stylesheet" href="/markbind/css/codeblock-light.min.css">
<link rel="stylesheet" href="/markbind/css/markbind.min.css">
<script src="/markbind/js/polyfill.min.js"></script>
<script src="/markbind/js/vue.min.js"></script>
<script src="/markbind/js/markbind.min.js"></script>
<script src="Configuration.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">
<link rel="icon" href="/images/SeEduLogo.png">
</head>
<script>
const baseUrl = ''
</script>

<body>
<div id="app">
<header sticky>
<navbar type="dark">
<template #brand><a href="/index.html" title="Home" class="navbar-brand">ProjectEx</a></template>
<li><a highlight-on="sibling-or-child" href="/userGuide/UserGuide.html" class="nav-link">User Guide</a></li>
<li><a highlight-on="sibling-or-child" href="/developerGuide/DeveloperGuide.html" class="nav-link">Developer Guide</a></li>
<li><a highlight-on="sibling-or-child" href="/team/AboutUs.html" class="nav-link">About Us</a></li>
<li><a href="https://github.com/se-edu" target="_blank" class="nav-link"><span><span aria-hidden="true" class="fab fa-github"></span></span></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="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="/userGuide/UserGuide.html">User Guide</a>

<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="/userGuide/QuickStart.html">Quick Start</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-1" onclick="handleSiteNavClick(this)"><a href="/userGuide/Features.html">Features</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-1" onclick="handleSiteNavClick(this)"><a href="/userGuide/FAQ.html">FAQ</a></div>
</li>
</ul>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-0" onclick="handleSiteNavClick(this)"><a href="/developerGuide/DeveloperGuide.html">Developer Guide</a>

<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="/developerGuide/SettingUp.html">Setting Up</a>

<div class="site-nav-dropdown-btn-container"><i class="site-nav-dropdown-btn-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-list">
<li>
<div class="site-nav-default-list-item site-nav-list-item-2" onclick="handleSiteNavClick(this)"><a href="/developerGuide/TracingCode.html">Tutorial: Tracing code</a></div>
</li>
</ul>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-1" onclick="handleSiteNavClick(this)"><a href="/developerGuide/Design.html">Design</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-1" onclick="handleSiteNavClick(this)"><a href="/developerGuide/Implementation.html">Implementation</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-1" onclick="handleSiteNavClick(this)">Project Guides

<div class="site-nav-dropdown-btn-container"><i class="site-nav-dropdown-btn-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-list">
<li>
<div class="site-nav-default-list-item site-nav-list-item-2" onclick="handleSiteNavClick(this)"><a href="/developerGuide/Documentation.html">Documentation</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-2" onclick="handleSiteNavClick(this)"><a href="/developerGuide/Testing.html">Testing</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-2" onclick="handleSiteNavClick(this)"><a href="/developerGuide/Configuration.html">Configuration</a></div>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-2" onclick="handleSiteNavClick(this)"><a href="/developerGuide/DevOps.html">DevOps</a></div>
</li>
</ul>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-1" onclick="handleSiteNavClick(this)">Appendix

<div class="site-nav-dropdown-btn-container"><i class="site-nav-dropdown-btn-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-list">
<li>
<div class="site-nav-default-list-item site-nav-list-item-2" onclick="handleSiteNavClick(this)"><a href="/developerGuide/Requirements.html">Requirements</a></div>
</li>
</ul>
</li>
</ul>
</li>
<li>
<div class="site-nav-default-list-item site-nav-list-item-0" onclick="handleSiteNavClick(this)"><a href="/team/AboutUs.html">About Us</a>

<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="/team/johndoe.html">Contributor Portfolio Template</a></div>
</li>
</ul>
</li>
</overlay-source>
</site-nav>
</div>
</overlay-source>
<div id="content-wrapper">

<h1 id="configuration-guide">Configuration guide<a class="fa fa-anchor" href="#configuration-guide" onclick="event.stopPropagation()"></a></h1>
<box type="tip">
This page can be used to understand how to configure the application such as descriptions of the config file and how to change the configuration.
</box>
<p>Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: <code class="hljs inline no-lang" v-pre>config.json</code>).</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>
</div>
<footer>

<div class="text-center">
<small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.3.0</a>]</small>
</div>
</footer>
</div>
</body>
<script src="/markbind/js/bootstrap-utility.min.js"></script>
<script>
MarkBind.setupWithSearch()
</script>

</html>
Loading
Loading