Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 2 additions & 5 deletions asset/css/markbind.css
Original file line number Diff line number Diff line change
Expand Up @@ -116,11 +116,8 @@ footer {
/* Side Navigation menus */

.spacer-top {
/*
spacer-top class is a work around for MarkBind <navbar> component using "position: fixed".
This class can be removed once the component's position type is changed.
*/
padding-top: 70px;
/* This class is to ensure adequate spacing of contents from the top of the page */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just wondering - should this comment be placed outside the class definition (even though the comment was previously inside the class definition)? 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this section, how I formatted it was

/**
  * Main section description
  */

/* sub section one */

/* sub section two */

.some-class {
  /* class description */
}

My intention was to separate sub section title comments from class descriptions

padding-top: 1rem;
}

.scrollable {
Expand Down
8 changes: 4 additions & 4 deletions asset/js/vue-strap.min.js

Large diffs are not rendered by default.

18 changes: 18 additions & 0 deletions docs/_markbind/headers/header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<header>
<link rel="stylesheet" href="../css/main.css">
<navbar type="inverse">
<a slot="brand" href="../index.html" title="Home" class="navbar-brand"><img src="../images/logo-darkbackground.png" height="20" /></a>
<li><a href="../index.html" class="nav-link">HOME</a></li>
<li><a href="../userGuide/index.html" class="nav-link">DOCS</a></li>
<li><a href="../showcase.html" class="nav-link">SHOWCASE</a></li>
<li><a href="../about.html" class="nav-link">ABOUT</a></li>
<li>
<a href="https://github.com/MarkBind/markbind" target="_blank" class="nav-link"><md>:fab-github:</md></a>
</li>
<li slot="right">
<form class="navbar-form">
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback" menu-align-right></searchbar>
</form>
</li>
</navbar>
</header>
3 changes: 1 addition & 2 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<frontmatter>
title: "About Us"
header: header.md
footer: footer.md
</frontmatter>

<include src="./common/header.md" />

# About Us

<span class="lead">MarkBind is a project **based in [National University of Singapore, School of Computing](http://www.comp.nus.edu.sg/)**, and is funded by an education grant from [NUS Center for Development of Teaching and Learning](http://www.cdtl.nus.edu.sg/).</span>
Expand Down
16 changes: 0 additions & 16 deletions docs/common/header.md

This file was deleted.

3 changes: 1 addition & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<frontmatter>
title: "Generate More Dynamic Websites from Markdown Text"
header: header.md
footer: footer.md
</frontmatter>

<include src="./common/header.md" />

<h1 class="display-3"><md>**MarkBind**</md></h1>

<span class="lead">
Expand Down
3 changes: 1 addition & 2 deletions docs/showcase.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<frontmatter>
title: "Showcase"
header: header.md
footer: footer.md
</frontmatter>

<include src="./common/header.md" />

# Examples of MarkBind Websites

## Course Websites
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/addingPages.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

<frontmatter>
title: "User Guide: {{ title }}"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>
Expand All @@ -11,8 +12,6 @@
<md>[_User Guide → {{ title }}_]({{ filename }}.html)</md>
</span>

<include src="../common/header.md" />


# {{ title }}

Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/authoringContents.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
<variable name="title" id="title">Authoring Contents</variable>
<frontmatter>
title: "User Guide: {{ title }}"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>

<include src="../common/header.md" />

# {{ title }}

{% set pages = [
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/cliCommands.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<frontmatter>
title: "User Guide: Command Line Interface (CLI)"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>

<include src="../common/header.md" />

# MarkBind CLI

### Overview
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/deployingTheSite.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
<variable name="title" id="title">Deploying the Site</variable>
<frontmatter>
title: "User Guide: {{ title }}"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
pageNav: default
</frontmatter>

<include src="../common/header.md" />

# {{ title }}

<span class="lead">
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/formattingContents.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

<frontmatter>
title: "User Guide: {{ title }}"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
pageNav: 2
Expand All @@ -12,8 +13,6 @@
<md>[_User Guide → {{ title }}_]({{ filename }}.html)</md>
</span>

<include src="../common/header.md" />

# {{ title }}

<span class="lead" id="overview">
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/fullSyntaxReference.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<frontmatter>
title: "User Guide: Full Syntax Reference"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>

<include src="../common/header.md" />

# Full Syntax Reference

{% set syntax_topics = {
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/gettingStarted.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
<variable name="title" id="title">Getting Started</variable>
<frontmatter>
title: "User Guide - {{ title }}"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>

<include src="../common/header.md" />

# {{ title }}

<big>**Prerequisites**</big>
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/glossary.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<frontmatter>
title: "Glossary"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>

<include src="../common/header.md" />

#### Live Preview

<span id="live-preview">
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/makingTheSiteSearchable.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

<frontmatter>
title: "User Guide: {{ title }}"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
pageNav: 2
Expand All @@ -12,8 +13,6 @@
<md>[_User Guide → {{ title }}_]({{ filename }}.html)</md>
</span>

<include src="../common/header.md" />

# {{ title }}

<span class="lead" id="overview">
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/markBindInTheProjectWorkflow.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
<variable name="title" id="title">MarkBind in the Project Workflow</variable>
<frontmatter>
title: "User Guide: {{ title }}"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>

<include src="../common/header.md" />

# {{ title }}

<span class="lead">
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/markBindSyntaxOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

<frontmatter>
title: "User Guide: {{ title }} "
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>
Expand All @@ -11,8 +12,6 @@
[_User Guide → {{ title }}_]({{ filename }}.html)
</span>

<include src="../common/header.md" />

# {{ title }}


Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/readerFacingFeatures.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<frontmatter>
title: "User Guide: Reader-Facing Features"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>

<include src="../common/header.md" />

# Reader-Facing Features

<include src="fullSyntaxReference.md#dummy" optional />
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/reusingContents.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

<frontmatter>
title: "User Guide: {{ title }}"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
pageNav: 4
Expand All @@ -12,8 +13,6 @@
<md>[_User Guide → {{ title }}_]({{ filename }}.html)</md>
</span>

<include src="../common/header.md" />

# {{ title }}

<span class="lead" id="overview">
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/siteConfiguration.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
<frontmatter>
title: "Configuring the Site"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
keywords: site.json
</frontmatter>

<include src="../common/header.md" />

# Configuring the Site

<span class="lead">
Expand Down
11 changes: 8 additions & 3 deletions docs/userGuide/syntax/navBars.mbdf
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,17 @@

**Navbar allows visitors of your website to navigate through pages easily.**

<box type="warning">
<markdown>
Note: **Navbars** should be placed within a [header file]({{ baseUrl }}/userguide/tweakingthepagestructure.html#headers) to ensure that they are correctly positioned at the top of the page, above the [site navigation]({{ baseUrl }}/userGuide/tweakingThePageStructure.html#site-navigation-menus) and [page navigation]({{ baseUrl }}/userGuide/tweakingThePageStructure.html#page-navigation-menus) menus.
</markdown>
</box>

<include src="outputBox.md" boilerplate >
<span id="code">

```html
<navbar placement="top" type="inverse">
<navbar type="inverse">
<!-- Brand as slot -->
<a slot="brand" href="/" title="Home" class="navbar-brand">MarkBind</a>
<!-- You can use dropdown component -->
Expand Down Expand Up @@ -41,14 +47,13 @@

Name | Type | Default | Description
--- | --- | --- | ---
placement | `String` | `''` | Supports: `top`, `bottom`, `static`, or empty for normal.
type | `String` | `default` | Supports: `inverse`, `default`.


<span id="short" class="d-none">

```html
<navbar placement="top" type="inverse">
<navbar type="inverse">
<!-- Brand as slot -->
<a slot="brand" href="/" title="Home" class="navbar-brand">MarkBind</a>
<!-- You can use dropdown component -->
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/syntaxCheatSheet.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<frontmatter>
title: "User Guide: Syntax Cheat Sheet"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>

<include src="../common/header.md" />

# Syntax Cheat Sheet

{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/themes.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
<variable name="title" id="title">Themes</variable>
<frontmatter>
title: "User Guide: {{ title }}"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>

<include src="../common/header.md" />

# {{ title }}

<span class="lead">
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/tipsAndTricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@

<frontmatter>
title: "User Guide: {{ title | safe }}"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>

<include src="../common/header.md" />

# {{ title | safe }}

<span id="escapingCharacters">
Expand Down
3 changes: 1 addition & 2 deletions docs/userGuide/tweakingThePageStructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

<frontmatter>
title: "User Guide: {{ title }}"
header: header.md
footer: footer.md
siteNav: userGuideSections.md
pageNav: 3
Expand All @@ -12,8 +13,6 @@
<md>[_User Guide → {{ title }}_]({{ filename }}.html)</md>
</span>

<include src="../common/header.md" />

# Tweaking the Page Structure

<span class="lead" id="overview">**MarkBind offers several ways to easily tweak the overall structure of a page**, for example, using headers, footers, scripts, or stylesheets.</span>
Expand Down
Loading