Skip to content

[v2] Fix anchor navigation in panel headers#1191

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
le0tan merged 6 commits into from
Apr 15, 2020
Merged

[v2] Fix anchor navigation in panel headers #1191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fad6f5b
Integrate the plugin as part of MarkBind
le0tan Apr 11, 2020
58ddd5e
Resolve comments
le0tan Apr 11, 2020
6bdb2dd
Update documentation and remove unnecessary code
le0tan Apr 12, 2020
a594505
Merge remote-tracking branch 'upstream/master' into issue-1104-v4
le0tan Apr 12, 2020
87183c2
Use fixed attr instead of class="fixed-header"
le0tan Apr 14, 2020
a98624e
Add additional offset for .nav-inner
le0tan Apr 15, 2020
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
2 changes: 1 addition & 1 deletion asset/css/markbind.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
position: fixed;
width: 100%;
z-index: 1000;
Expand Down
20 changes: 9 additions & 11 deletions asset/js/setup.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
const headerSelector = jQuery('header');
const isFixed = headerSelector.filter('.header-fixed').length !== 0;
const headerSelector = jQuery('header[fixed]');
const isFixed = headerSelector.length !== 0;
if (!isFixed) {
return;
}

const headerHeight = headerSelector.height();
const bufferHeight = 1;
jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);

@ang-zeyuang-zeyuApr 12, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

would it be possible to just insert the padding for the main container and not its 3 sub containers?
fixedheader

@le0tanle0tanApr 14, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

As far as I'm concerned it doesn't work...

@ang-zeyuang-zeyuApr 14, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ok, might be better to leave it this way as well: .css('nav-inner') needs to be offsetted with the original padding

navbarpadding

@le0tanle0tanApr 15, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

just did that, wondering if we need to add 1rem to content-wrapper as well, but probably better leave it as a future first timer issue?

@ang-zeyuang-zeyuApr 15, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Good idea, would make it seem less squeezed to the top. Let's leave it as a first timer issue then, though if you want to include it here it'd be nice as well

insertCss(
`span.anchor {
display: block;
position: relative;
top: calc(-${headerHeight}px - ${bufferHeight}rem)
}`,
);
insertCss(`span.card-container::before {
display: block;
content: '';
margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
height: calc(${headerHeight}px + ${bufferHeight}rem);
}`);
jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
if (heading.id) {
/**
* Fixing the top navbar would break anchor navigation,
* by creating empty spans above the <h> tag we can prevent
* the headings from being covered by the navbar.
*/
const spanId = heading.id;
heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
}
});
Expand Down
2 changes: 1 addition & 1 deletion docs/_markbind/headers/header.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
<link rel="stylesheet" href="{{baseUrl}}/css/main.css">
<navbar type="dark">
<a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_markbind/layouts/devGuide/header.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
<link rel="stylesheet" href="{{baseUrl}}/css/main.css">
<navbar type="dark">
<a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_markbind/layouts/userGuide/header.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
<link rel="stylesheet" href="{{baseUrl}}/css/main.css">
<navbar type="dark">
<a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down
11 changes: 11 additions & 0 deletions docs/userGuide/syntax/headers.mbdf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,17 @@ In the page that you want to include the header:
```
</div>

You can fix the header to be always on the top by add `fixed` attribute to the `<header>` tag of your header file:

{{ icon_example }}
**`_markbind/headers/`**`header.md`:
Comment thread
le0tan marked this conversation as resolved.
```html
<header fixed>
<!--Normal header stuff goes here-->
</header>

```

Notes:
- Any inline headers will be removed by MarkBind to ensure compatibility with header files.
- If a [Layout]({{ baseUrl }}/userGuide/tweakingThePageStructure.html#page-layouts) is specified, the header file specified in the `<frontmatter>` will override the header within the Layout.
Expand Down
21 changes: 19 additions & 2 deletions src/Page.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ class Page {
* @type {boolean}
*/
this.hasSiteNav = false;

/**
* Flag to indicate whether a fixed header is enabled.
* @type {boolean}
*/
this.fixedHeader = false;
}

/**
Expand DownExpand Up@@ -604,9 +610,11 @@ class Page {

/**
* Inserts the page layout's header to the start of the page
* Determines if a fixed header is present, update the page config accordingly
* @param pageData a page with its front matter collected
* @param {FileConfig} fileConfig
*/
insertHeaderFile(pageData) {
insertHeaderFile(pageData, fileConfig) {
const { header } = this.frontMatter;
if (header === FRONT_MATTER_NONE_ATTR) {
return pageData;
Expand All@@ -624,6 +632,13 @@ class Page {
}
// Retrieve Markdown file contents
const headerContent = fs.readFileSync(headerPath, 'utf8');
// Decide if fixed header is applied
const headerSelector = cheerio.load(headerContent)('header');
if (headerSelector.length >= 1
&& headerSelector[0].attribs.fixed !== undefined) {
this.fixedHeader = true;
fileConfig.fixedHeader = true;
}
// Set header file as an includedFile
this.includedFiles.add(headerPath);
// Map variables
Expand DownExpand Up@@ -894,6 +909,7 @@ class Page {
* @property {string} rootPath
* @property {Object<string, any>} userDefinedVariablesMap
* @property {Object<string, number>} headerIdMap
* @property {boolean} fixedHeader indicates whether the header of the page is fixed
*/

generate(builtFiles) {
Expand All@@ -911,6 +927,7 @@ class Page {
rootPath: this.rootPath,
userDefinedVariablesMap: this.userDefinedVariablesMap,
headerIdMap: this.headerIdMap,
fixedHeader: this.fixedHeader,
};
return new Promise((resolve, reject) => {
markbinder.includeFile(this.sourcePath, fileConfig)
Expand All@@ -924,7 +941,7 @@ class Page {
.then(result => this.collectPluginSources(result))
.then(result => this.preRender(result))
.then(result => this.insertSiteNav((result)))
.then(result => this.insertHeaderFile(result))
.then(result => this.insertHeaderFile(result, fileConfig))
.then(result => this.insertFooterFile(result))
.then(result => Page.insertTemporaryStyles(result))
.then(result => markbinder.resolveBaseUrl(result, fileConfig))
Expand Down
9 changes: 8 additions & 1 deletion src/lib/markbind/src/parser.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -292,7 +292,9 @@ class Parser {
node.name = node.name.toLowerCase();
}

if ((/^h[1-6]$/).test(node.name) && !node.attribs.id) {
const isHeadingTag = (/^h[1-6]$/).test(node.name);

if (isHeadingTag && !node.attribs.id) {
const textContent = utils.getTextContent(node);
// remove the '&lt;' and '&gt;' symbols that markdown-it uses to escape '<' and '>'
const cleanedContent = textContent.replace(/&lt;|&gt;/g, '');
Expand DownExpand Up@@ -353,6 +355,11 @@ class Parser {

componentParser.postParseComponents(node, this._onError);

// If a fixed header is applied to this page, generate dummy spans as anchor points
if (config.fixedHeader && isHeadingTag && node.attribs.id) {
cheerio(node).append(cheerio.parseHTML(`<span id="${node.attribs.id}" class="anchor"></span>`));
}

return node;
}

Expand Down
2 changes: 1 addition & 1 deletion test/functional/test_site/expected/markbind/css/markbind.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
position: fixed;
width: 100%;
z-index: 1000;
Expand Down
20 changes: 9 additions & 11 deletions test/functional/test_site/expected/markbind/js/setup.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
const headerSelector = jQuery('header');
const isFixed = headerSelector.filter('.header-fixed').length !== 0;
const headerSelector = jQuery('header[fixed]');
const isFixed = headerSelector.length !== 0;
if (!isFixed) {
return;
}

const headerHeight = headerSelector.height();
const bufferHeight = 1;
jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
insertCss(
`span.anchor {
display: block;
position: relative;
top: calc(-${headerHeight}px - ${bufferHeight}rem)
}`,
);
insertCss(`span.card-container::before {
display: block;
content: '';
margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
height: calc(${headerHeight}px + ${bufferHeight}rem);
}`);
jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
if (heading.id) {
/**
* Fixing the top navbar would break anchor navigation,
* by creating empty spans above the <h> tag we can prevent
* the headings from being covered by the navbar.
*/
const spanId = heading.id;
heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
}
});
Expand Down
2 changes: 1 addition & 1 deletion test/functional/test_site_algolia_plugin/expected/markbind/css/markbind.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
position: fixed;
width: 100%;
z-index: 1000;
Expand Down
20 changes: 9 additions & 11 deletions test/functional/test_site_algolia_plugin/expected/markbind/js/setup.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
const headerSelector = jQuery('header');
const isFixed = headerSelector.filter('.header-fixed').length !== 0;
const headerSelector = jQuery('header[fixed]');
const isFixed = headerSelector.length !== 0;
if (!isFixed) {
return;
}

const headerHeight = headerSelector.height();
const bufferHeight = 1;
jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
insertCss(
`span.anchor {
display: block;
position: relative;
top: calc(-${headerHeight}px - ${bufferHeight}rem)
}`,
);
insertCss(`span.card-container::before {
display: block;
content: '';
margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
height: calc(${headerHeight}px + ${bufferHeight}rem);
}`);
jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
if (heading.id) {
/**
* Fixing the top navbar would break anchor navigation,
* by creating empty spans above the <h> tag we can prevent
* the headings from being covered by the navbar.
*/
const spanId = heading.id;
heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
}
});
Expand Down
2 changes: 1 addition & 1 deletion test/functional/test_site_convert/expected/markbind/css/markbind.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
position: fixed;
width: 100%;
z-index: 1000;
Expand Down
20 changes: 9 additions & 11 deletions test/functional/test_site_convert/expected/markbind/js/setup.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
const headerSelector = jQuery('header');
const isFixed = headerSelector.filter('.header-fixed').length !== 0;
const headerSelector = jQuery('header[fixed]');
const isFixed = headerSelector.length !== 0;
if (!isFixed) {
return;
}

const headerHeight = headerSelector.height();
const bufferHeight = 1;
jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
insertCss(
`span.anchor {
display: block;
position: relative;
top: calc(-${headerHeight}px - ${bufferHeight}rem)
}`,
);
insertCss(`span.card-container::before {
display: block;
content: '';
margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
height: calc(${headerHeight}px + ${bufferHeight}rem);
}`);
jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
if (heading.id) {
/**
* Fixing the top navbar would break anchor navigation,
* by creating empty spans above the <h> tag we can prevent
* the headings from being covered by the navbar.
*/
const spanId = heading.id;
heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
}
});
Expand Down
2 changes: 1 addition & 1 deletion test/functional/test_site_expressive_layout/expected/markbind/css/markbind.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
position: fixed;
width: 100%;
z-index: 1000;
Expand Down
20 changes: 9 additions & 11 deletions test/functional/test_site_expressive_layout/expected/markbind/js/setup.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
const headerSelector = jQuery('header');
const isFixed = headerSelector.filter('.header-fixed').length !== 0;
const headerSelector = jQuery('header[fixed]');
const isFixed = headerSelector.length !== 0;
if (!isFixed) {
return;
}

const headerHeight = headerSelector.height();
const bufferHeight = 1;
jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
insertCss(
`span.anchor {
display: block;
position: relative;
top: calc(-${headerHeight}px - ${bufferHeight}rem)
}`,
);
insertCss(`span.card-container::before {
display: block;
content: '';
margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
height: calc(${headerHeight}px + ${bufferHeight}rem);
}`);
jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
if (heading.id) {
/**
* Fixing the top navbar would break anchor navigation,
* by creating empty spans above the <h> tag we can prevent
* the headings from being covered by the navbar.
*/
const spanId = heading.id;
heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
}
});
Expand Down
2 changes: 1 addition & 1 deletion test/functional/test_site_special_tags/expected/markbind/css/markbind.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
position: fixed;
width: 100%;
z-index: 1000;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[v2] Fix anchor navigation in panel headers by le0tan · Pull Request #1191 · MarkBind/markbind · GitHub
Skip to content
[v2] Fix anchor navigation in panel headers#1191

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

le0tan
merged 6 commits into

from

Apr 15, 2020
 Merged


[v2] Fix anchor navigation in panel headers
#1191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fad6f5b

Integrate the plugin as part of MarkBind


le0tan Apr 11, 2020
58ddd5e

Resolve comments


le0tan Apr 11, 2020
6bdb2dd

Update documentation and remove unnecessary code


le0tan Apr 12, 2020
a594505

Merge remote-tracking branch 'upstream/master' into issue-1104-v4


le0tan Apr 12, 2020
87183c2

Use fixed attr instead of class="fixed-header"


le0tan Apr 14, 2020
a98624e

Add additional offset for .nav-inner


le0tan Apr 15, 2020

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


2 changes: 1 addition & 1 deletion
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
@ang-zeyuang-zeyuApr 12, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

would it be possible to just insert the padding for the main container and not its 3 sub containers?
fixedheader
@le0tanle0tanApr 14, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As far as I'm concerned it doesn't work...
@ang-zeyuang-zeyuApr 14, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

ok, might be better to leave it this way as well: .css('nav-inner') needs to be offsetted with the original padding
navbarpadding
@le0tanle0tanApr 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

just did that, wondering if we need to add 1rem to content-wrapper as well, but probably better leave it as a future first timer issue?
@ang-zeyuang-zeyuApr 15, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Good idea, would make it seem less squeezed to the top. Let's leave it as a first timer issue then, though if you want to include it here it'd be nice as well
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/headers/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/devGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/userGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

11 changes: 11 additions & 0 deletions
docs/userGuide/syntax/headers.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,17 @@ In the page that you want to include the header:
```
</div>

You can fix the header to be always on the top by add `fixed` attribute to the `<header>` tag of your header file:

{{ icon_example }}
**`_markbind/headers/`**`header.md`:
Comment thread
le0tan marked this conversation as resolved.

```html
<header fixed>
 <!--Normal header stuff goes here-->
</header>

```

Notes:
- Any inline headers will be removed by MarkBind to ensure compatibility with header files.
- If a [Layout]({{ baseUrl }}/userGuide/tweakingThePageStructure.html#page-layouts) is specified, the header file specified in the `<frontmatter>` will override the header within the Layout.
Expand Down

21 changes: 19 additions & 2 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ class Page {
 * @type {boolean}
 */
 this.hasSiteNav = false;

 /**
 * Flag to indicate whether a fixed header is enabled.
 * @type {boolean}
 */
 this.fixedHeader = false;
 }

 /**
Expand DownExpand Up@@ -604,9 +610,11 @@ class Page {

 /**
 * Inserts the page layout's header to the start of the page
 * Determines if a fixed header is present, update the page config accordingly
 * @param pageData a page with its front matter collected
 * @param {FileConfig} fileConfig
 */
 insertHeaderFile(pageData) {
 insertHeaderFile(pageData, fileConfig) {
 const { header } = this.frontMatter;
 if (header === FRONT_MATTER_NONE_ATTR) {
 return pageData;
Expand All@@ -624,6 +632,13 @@ class Page {
 }
 // Retrieve Markdown file contents
 const headerContent = fs.readFileSync(headerPath, 'utf8');
 // Decide if fixed header is applied
 const headerSelector = cheerio.load(headerContent)('header');
 if (headerSelector.length >= 1
 && headerSelector[0].attribs.fixed !== undefined) {
 this.fixedHeader = true;
 fileConfig.fixedHeader = true;
 }
 // Set header file as an includedFile
 this.includedFiles.add(headerPath);
 // Map variables
Expand DownExpand Up@@ -894,6 +909,7 @@ class Page {
 * @property {string} rootPath
 * @property {Object<string, any>} userDefinedVariablesMap
 * @property {Object<string, number>} headerIdMap
 * @property {boolean} fixedHeader indicates whether the header of the page is fixed
 */

 generate(builtFiles) {
Expand All@@ -911,6 +927,7 @@ class Page {
 rootPath: this.rootPath,
 userDefinedVariablesMap: this.userDefinedVariablesMap,
 headerIdMap: this.headerIdMap,
 fixedHeader: this.fixedHeader,
 };
 return new Promise((resolve, reject) => {
 markbinder.includeFile(this.sourcePath, fileConfig)
Expand All@@ -924,7 +941,7 @@ class Page {
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
 .then(result => this.insertHeaderFile(result, fileConfig))
 .then(result => this.insertFooterFile(result))
 .then(result => Page.insertTemporaryStyles(result))
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
Expand Down

9 changes: 8 additions & 1 deletion
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -292,7 +292,9 @@ class Parser {
 node.name = node.name.toLowerCase();
 }

 if ((/^h[1-6]$/).test(node.name) && !node.attribs.id) {
 const isHeadingTag = (/^h[1-6]$/).test(node.name);

 if (isHeadingTag && !node.attribs.id) {
 const textContent = utils.getTextContent(node);
 // remove the '&lt;' and '&gt;' symbols that markdown-it uses to escape '<' and '>'
 const cleanedContent = textContent.replace(/&lt;|&gt;/g, '');
Expand DownExpand Up@@ -353,6 +355,11 @@ class Parser {

 componentParser.postParseComponents(node, this._onError);

 // If a fixed header is applied to this page, generate dummy spans as anchor points
 if (config.fixedHeader && isHeadingTag && node.attribs.id) {
 cheerio(node).append(cheerio.parseHTML(`<span id="${node.attribs.id}" class="anchor"></span>`));
 }

 return node;
 }

Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_algolia_plugin/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_algolia_plugin/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_convert/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_convert/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_expressive_layout/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_expressive_layout/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_special_tags/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[v2] Fix anchor navigation in panel headers by le0tan · Pull Request #1191 · MarkBind/markbind · GitHub
Skip to content
[v2] Fix anchor navigation in panel headers#1191

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

le0tan
merged 6 commits into

from

Apr 15, 2020
 Merged


[v2] Fix anchor navigation in panel headers
#1191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fad6f5b

Integrate the plugin as part of MarkBind


le0tan Apr 11, 2020
58ddd5e

Resolve comments


le0tan Apr 11, 2020
6bdb2dd

Update documentation and remove unnecessary code


le0tan Apr 12, 2020
a594505

Merge remote-tracking branch 'upstream/master' into issue-1104-v4


le0tan Apr 12, 2020
87183c2

Use fixed attr instead of class="fixed-header"


le0tan Apr 14, 2020
a98624e

Add additional offset for .nav-inner


le0tan Apr 15, 2020

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


2 changes: 1 addition & 1 deletion
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
@ang-zeyuang-zeyuApr 12, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

would it be possible to just insert the padding for the main container and not its 3 sub containers?
fixedheader
@le0tanle0tanApr 14, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As far as I'm concerned it doesn't work...
@ang-zeyuang-zeyuApr 14, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

ok, might be better to leave it this way as well: .css('nav-inner') needs to be offsetted with the original padding
navbarpadding
@le0tanle0tanApr 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

just did that, wondering if we need to add 1rem to content-wrapper as well, but probably better leave it as a future first timer issue?
@ang-zeyuang-zeyuApr 15, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Good idea, would make it seem less squeezed to the top. Let's leave it as a first timer issue then, though if you want to include it here it'd be nice as well
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/headers/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/devGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/userGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

11 changes: 11 additions & 0 deletions
docs/userGuide/syntax/headers.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,17 @@ In the page that you want to include the header:
```
</div>

You can fix the header to be always on the top by add `fixed` attribute to the `<header>` tag of your header file:

{{ icon_example }}
**`_markbind/headers/`**`header.md`:
Comment thread
le0tan marked this conversation as resolved.

```html
<header fixed>
 <!--Normal header stuff goes here-->
</header>

```

Notes:
- Any inline headers will be removed by MarkBind to ensure compatibility with header files.
- If a [Layout]({{ baseUrl }}/userGuide/tweakingThePageStructure.html#page-layouts) is specified, the header file specified in the `<frontmatter>` will override the header within the Layout.
Expand Down

21 changes: 19 additions & 2 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ class Page {
 * @type {boolean}
 */
 this.hasSiteNav = false;

 /**
 * Flag to indicate whether a fixed header is enabled.
 * @type {boolean}
 */
 this.fixedHeader = false;
 }

 /**
Expand DownExpand Up@@ -604,9 +610,11 @@ class Page {

 /**
 * Inserts the page layout's header to the start of the page
 * Determines if a fixed header is present, update the page config accordingly
 * @param pageData a page with its front matter collected
 * @param {FileConfig} fileConfig
 */
 insertHeaderFile(pageData) {
 insertHeaderFile(pageData, fileConfig) {
 const { header } = this.frontMatter;
 if (header === FRONT_MATTER_NONE_ATTR) {
 return pageData;
Expand All@@ -624,6 +632,13 @@ class Page {
 }
 // Retrieve Markdown file contents
 const headerContent = fs.readFileSync(headerPath, 'utf8');
 // Decide if fixed header is applied
 const headerSelector = cheerio.load(headerContent)('header');
 if (headerSelector.length >= 1
 && headerSelector[0].attribs.fixed !== undefined) {
 this.fixedHeader = true;
 fileConfig.fixedHeader = true;
 }
 // Set header file as an includedFile
 this.includedFiles.add(headerPath);
 // Map variables
Expand DownExpand Up@@ -894,6 +909,7 @@ class Page {
 * @property {string} rootPath
 * @property {Object<string, any>} userDefinedVariablesMap
 * @property {Object<string, number>} headerIdMap
 * @property {boolean} fixedHeader indicates whether the header of the page is fixed
 */

 generate(builtFiles) {
Expand All@@ -911,6 +927,7 @@ class Page {
 rootPath: this.rootPath,
 userDefinedVariablesMap: this.userDefinedVariablesMap,
 headerIdMap: this.headerIdMap,
 fixedHeader: this.fixedHeader,
 };
 return new Promise((resolve, reject) => {
 markbinder.includeFile(this.sourcePath, fileConfig)
Expand All@@ -924,7 +941,7 @@ class Page {
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
 .then(result => this.insertHeaderFile(result, fileConfig))
 .then(result => this.insertFooterFile(result))
 .then(result => Page.insertTemporaryStyles(result))
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
Expand Down

9 changes: 8 additions & 1 deletion
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -292,7 +292,9 @@ class Parser {
 node.name = node.name.toLowerCase();
 }

 if ((/^h[1-6]$/).test(node.name) && !node.attribs.id) {
 const isHeadingTag = (/^h[1-6]$/).test(node.name);

 if (isHeadingTag && !node.attribs.id) {
 const textContent = utils.getTextContent(node);
 // remove the '&lt;' and '&gt;' symbols that markdown-it uses to escape '<' and '>'
 const cleanedContent = textContent.replace(/&lt;|&gt;/g, '');
Expand DownExpand Up@@ -353,6 +355,11 @@ class Parser {

 componentParser.postParseComponents(node, this._onError);

 // If a fixed header is applied to this page, generate dummy spans as anchor points
 if (config.fixedHeader && isHeadingTag && node.attribs.id) {
 cheerio(node).append(cheerio.parseHTML(`<span id="${node.attribs.id}" class="anchor"></span>`));
 }

 return node;
 }

Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_algolia_plugin/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_algolia_plugin/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_convert/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_convert/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_expressive_layout/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_expressive_layout/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_special_tags/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[v2] Fix anchor navigation in panel headers by le0tan · Pull Request #1191 · MarkBind/markbind · GitHub
Skip to content
[v2] Fix anchor navigation in panel headers#1191

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

le0tan
merged 6 commits into

from

Apr 15, 2020
 Merged


[v2] Fix anchor navigation in panel headers
#1191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fad6f5b

Integrate the plugin as part of MarkBind


le0tan Apr 11, 2020
58ddd5e

Resolve comments


le0tan Apr 11, 2020
6bdb2dd

Update documentation and remove unnecessary code


le0tan Apr 12, 2020
a594505

Merge remote-tracking branch 'upstream/master' into issue-1104-v4


le0tan Apr 12, 2020
87183c2

Use fixed attr instead of class="fixed-header"


le0tan Apr 14, 2020
a98624e

Add additional offset for .nav-inner


le0tan Apr 15, 2020

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


2 changes: 1 addition & 1 deletion
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
@ang-zeyuang-zeyuApr 12, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

would it be possible to just insert the padding for the main container and not its 3 sub containers?
fixedheader
@le0tanle0tanApr 14, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As far as I'm concerned it doesn't work...
@ang-zeyuang-zeyuApr 14, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

ok, might be better to leave it this way as well: .css('nav-inner') needs to be offsetted with the original padding
navbarpadding
@le0tanle0tanApr 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

just did that, wondering if we need to add 1rem to content-wrapper as well, but probably better leave it as a future first timer issue?
@ang-zeyuang-zeyuApr 15, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Good idea, would make it seem less squeezed to the top. Let's leave it as a first timer issue then, though if you want to include it here it'd be nice as well
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/headers/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/devGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/userGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

11 changes: 11 additions & 0 deletions
docs/userGuide/syntax/headers.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,17 @@ In the page that you want to include the header:
```
</div>

You can fix the header to be always on the top by add `fixed` attribute to the `<header>` tag of your header file:

{{ icon_example }}
**`_markbind/headers/`**`header.md`:
Comment thread
le0tan marked this conversation as resolved.

```html
<header fixed>
 <!--Normal header stuff goes here-->
</header>

```

Notes:
- Any inline headers will be removed by MarkBind to ensure compatibility with header files.
- If a [Layout]({{ baseUrl }}/userGuide/tweakingThePageStructure.html#page-layouts) is specified, the header file specified in the `<frontmatter>` will override the header within the Layout.
Expand Down

21 changes: 19 additions & 2 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ class Page {
 * @type {boolean}
 */
 this.hasSiteNav = false;

 /**
 * Flag to indicate whether a fixed header is enabled.
 * @type {boolean}
 */
 this.fixedHeader = false;
 }

 /**
Expand DownExpand Up@@ -604,9 +610,11 @@ class Page {

 /**
 * Inserts the page layout's header to the start of the page
 * Determines if a fixed header is present, update the page config accordingly
 * @param pageData a page with its front matter collected
 * @param {FileConfig} fileConfig
 */
 insertHeaderFile(pageData) {
 insertHeaderFile(pageData, fileConfig) {
 const { header } = this.frontMatter;
 if (header === FRONT_MATTER_NONE_ATTR) {
 return pageData;
Expand All@@ -624,6 +632,13 @@ class Page {
 }
 // Retrieve Markdown file contents
 const headerContent = fs.readFileSync(headerPath, 'utf8');
 // Decide if fixed header is applied
 const headerSelector = cheerio.load(headerContent)('header');
 if (headerSelector.length >= 1
 && headerSelector[0].attribs.fixed !== undefined) {
 this.fixedHeader = true;
 fileConfig.fixedHeader = true;
 }
 // Set header file as an includedFile
 this.includedFiles.add(headerPath);
 // Map variables
Expand DownExpand Up@@ -894,6 +909,7 @@ class Page {
 * @property {string} rootPath
 * @property {Object<string, any>} userDefinedVariablesMap
 * @property {Object<string, number>} headerIdMap
 * @property {boolean} fixedHeader indicates whether the header of the page is fixed
 */

 generate(builtFiles) {
Expand All@@ -911,6 +927,7 @@ class Page {
 rootPath: this.rootPath,
 userDefinedVariablesMap: this.userDefinedVariablesMap,
 headerIdMap: this.headerIdMap,
 fixedHeader: this.fixedHeader,
 };
 return new Promise((resolve, reject) => {
 markbinder.includeFile(this.sourcePath, fileConfig)
Expand All@@ -924,7 +941,7 @@ class Page {
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
 .then(result => this.insertHeaderFile(result, fileConfig))
 .then(result => this.insertFooterFile(result))
 .then(result => Page.insertTemporaryStyles(result))
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
Expand Down

9 changes: 8 additions & 1 deletion
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -292,7 +292,9 @@ class Parser {
 node.name = node.name.toLowerCase();
 }

 if ((/^h[1-6]$/).test(node.name) && !node.attribs.id) {
 const isHeadingTag = (/^h[1-6]$/).test(node.name);

 if (isHeadingTag && !node.attribs.id) {
 const textContent = utils.getTextContent(node);
 // remove the '&lt;' and '&gt;' symbols that markdown-it uses to escape '<' and '>'
 const cleanedContent = textContent.replace(/&lt;|&gt;/g, '');
Expand DownExpand Up@@ -353,6 +355,11 @@ class Parser {

 componentParser.postParseComponents(node, this._onError);

 // If a fixed header is applied to this page, generate dummy spans as anchor points
 if (config.fixedHeader && isHeadingTag && node.attribs.id) {
 cheerio(node).append(cheerio.parseHTML(`<span id="${node.attribs.id}" class="anchor"></span>`));
 }

 return node;
 }

Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_algolia_plugin/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_algolia_plugin/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_convert/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_convert/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_expressive_layout/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_expressive_layout/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_special_tags/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[v2] Fix anchor navigation in panel headers by le0tan · Pull Request #1191 · MarkBind/markbind · GitHub
Skip to content
[v2] Fix anchor navigation in panel headers#1191

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

le0tan
merged 6 commits into

from

Apr 15, 2020
 Merged


[v2] Fix anchor navigation in panel headers
#1191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fad6f5b

Integrate the plugin as part of MarkBind


le0tan Apr 11, 2020
58ddd5e

Resolve comments


le0tan Apr 11, 2020
6bdb2dd

Update documentation and remove unnecessary code


le0tan Apr 12, 2020
a594505

Merge remote-tracking branch 'upstream/master' into issue-1104-v4


le0tan Apr 12, 2020
87183c2

Use fixed attr instead of class="fixed-header"


le0tan Apr 14, 2020
a98624e

Add additional offset for .nav-inner


le0tan Apr 15, 2020

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


2 changes: 1 addition & 1 deletion
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
@ang-zeyuang-zeyuApr 12, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

would it be possible to just insert the padding for the main container and not its 3 sub containers?
fixedheader
@le0tanle0tanApr 14, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As far as I'm concerned it doesn't work...
@ang-zeyuang-zeyuApr 14, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

ok, might be better to leave it this way as well: .css('nav-inner') needs to be offsetted with the original padding
navbarpadding
@le0tanle0tanApr 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

just did that, wondering if we need to add 1rem to content-wrapper as well, but probably better leave it as a future first timer issue?
@ang-zeyuang-zeyuApr 15, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Good idea, would make it seem less squeezed to the top. Let's leave it as a first timer issue then, though if you want to include it here it'd be nice as well
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/headers/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/devGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/userGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

11 changes: 11 additions & 0 deletions
docs/userGuide/syntax/headers.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,17 @@ In the page that you want to include the header:
```
</div>

You can fix the header to be always on the top by add `fixed` attribute to the `<header>` tag of your header file:

{{ icon_example }}
**`_markbind/headers/`**`header.md`:
Comment thread
le0tan marked this conversation as resolved.

```html
<header fixed>
 <!--Normal header stuff goes here-->
</header>

```

Notes:
- Any inline headers will be removed by MarkBind to ensure compatibility with header files.
- If a [Layout]({{ baseUrl }}/userGuide/tweakingThePageStructure.html#page-layouts) is specified, the header file specified in the `<frontmatter>` will override the header within the Layout.
Expand Down

21 changes: 19 additions & 2 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ class Page {
 * @type {boolean}
 */
 this.hasSiteNav = false;

 /**
 * Flag to indicate whether a fixed header is enabled.
 * @type {boolean}
 */
 this.fixedHeader = false;
 }

 /**
Expand DownExpand Up@@ -604,9 +610,11 @@ class Page {

 /**
 * Inserts the page layout's header to the start of the page
 * Determines if a fixed header is present, update the page config accordingly
 * @param pageData a page with its front matter collected
 * @param {FileConfig} fileConfig
 */
 insertHeaderFile(pageData) {
 insertHeaderFile(pageData, fileConfig) {
 const { header } = this.frontMatter;
 if (header === FRONT_MATTER_NONE_ATTR) {
 return pageData;
Expand All@@ -624,6 +632,13 @@ class Page {
 }
 // Retrieve Markdown file contents
 const headerContent = fs.readFileSync(headerPath, 'utf8');
 // Decide if fixed header is applied
 const headerSelector = cheerio.load(headerContent)('header');
 if (headerSelector.length >= 1
 && headerSelector[0].attribs.fixed !== undefined) {
 this.fixedHeader = true;
 fileConfig.fixedHeader = true;
 }
 // Set header file as an includedFile
 this.includedFiles.add(headerPath);
 // Map variables
Expand DownExpand Up@@ -894,6 +909,7 @@ class Page {
 * @property {string} rootPath
 * @property {Object<string, any>} userDefinedVariablesMap
 * @property {Object<string, number>} headerIdMap
 * @property {boolean} fixedHeader indicates whether the header of the page is fixed
 */

 generate(builtFiles) {
Expand All@@ -911,6 +927,7 @@ class Page {
 rootPath: this.rootPath,
 userDefinedVariablesMap: this.userDefinedVariablesMap,
 headerIdMap: this.headerIdMap,
 fixedHeader: this.fixedHeader,
 };
 return new Promise((resolve, reject) => {
 markbinder.includeFile(this.sourcePath, fileConfig)
Expand All@@ -924,7 +941,7 @@ class Page {
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
 .then(result => this.insertHeaderFile(result, fileConfig))
 .then(result => this.insertFooterFile(result))
 .then(result => Page.insertTemporaryStyles(result))
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
Expand Down

9 changes: 8 additions & 1 deletion
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -292,7 +292,9 @@ class Parser {
 node.name = node.name.toLowerCase();
 }

 if ((/^h[1-6]$/).test(node.name) && !node.attribs.id) {
 const isHeadingTag = (/^h[1-6]$/).test(node.name);

 if (isHeadingTag && !node.attribs.id) {
 const textContent = utils.getTextContent(node);
 // remove the '&lt;' and '&gt;' symbols that markdown-it uses to escape '<' and '>'
 const cleanedContent = textContent.replace(/&lt;|&gt;/g, '');
Expand DownExpand Up@@ -353,6 +355,11 @@ class Parser {

 componentParser.postParseComponents(node, this._onError);

 // If a fixed header is applied to this page, generate dummy spans as anchor points
 if (config.fixedHeader && isHeadingTag && node.attribs.id) {
 cheerio(node).append(cheerio.parseHTML(`<span id="${node.attribs.id}" class="anchor"></span>`));
 }

 return node;
 }

Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_algolia_plugin/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_algolia_plugin/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_convert/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_convert/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_expressive_layout/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_expressive_layout/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_special_tags/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[v2] Fix anchor navigation in panel headers by le0tan · Pull Request #1191 · MarkBind/markbind · GitHub
Skip to content
[v2] Fix anchor navigation in panel headers#1191

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

le0tan
merged 6 commits into

from

Apr 15, 2020
 Merged


[v2] Fix anchor navigation in panel headers
#1191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fad6f5b

Integrate the plugin as part of MarkBind


le0tan Apr 11, 2020
58ddd5e

Resolve comments


le0tan Apr 11, 2020
6bdb2dd

Update documentation and remove unnecessary code


le0tan Apr 12, 2020
a594505

Merge remote-tracking branch 'upstream/master' into issue-1104-v4


le0tan Apr 12, 2020
87183c2

Use fixed attr instead of class="fixed-header"


le0tan Apr 14, 2020
a98624e

Add additional offset for .nav-inner


le0tan Apr 15, 2020

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


2 changes: 1 addition & 1 deletion
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
@ang-zeyuang-zeyuApr 12, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

would it be possible to just insert the padding for the main container and not its 3 sub containers?
fixedheader
@le0tanle0tanApr 14, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As far as I'm concerned it doesn't work...
@ang-zeyuang-zeyuApr 14, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

ok, might be better to leave it this way as well: .css('nav-inner') needs to be offsetted with the original padding
navbarpadding
@le0tanle0tanApr 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

just did that, wondering if we need to add 1rem to content-wrapper as well, but probably better leave it as a future first timer issue?
@ang-zeyuang-zeyuApr 15, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Good idea, would make it seem less squeezed to the top. Let's leave it as a first timer issue then, though if you want to include it here it'd be nice as well
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/headers/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/devGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/userGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

11 changes: 11 additions & 0 deletions
docs/userGuide/syntax/headers.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,17 @@ In the page that you want to include the header:
```
</div>

You can fix the header to be always on the top by add `fixed` attribute to the `<header>` tag of your header file:

{{ icon_example }}
**`_markbind/headers/`**`header.md`:
Comment thread
le0tan marked this conversation as resolved.

```html
<header fixed>
 <!--Normal header stuff goes here-->
</header>

```

Notes:
- Any inline headers will be removed by MarkBind to ensure compatibility with header files.
- If a [Layout]({{ baseUrl }}/userGuide/tweakingThePageStructure.html#page-layouts) is specified, the header file specified in the `<frontmatter>` will override the header within the Layout.
Expand Down

21 changes: 19 additions & 2 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ class Page {
 * @type {boolean}
 */
 this.hasSiteNav = false;

 /**
 * Flag to indicate whether a fixed header is enabled.
 * @type {boolean}
 */
 this.fixedHeader = false;
 }

 /**
Expand DownExpand Up@@ -604,9 +610,11 @@ class Page {

 /**
 * Inserts the page layout's header to the start of the page
 * Determines if a fixed header is present, update the page config accordingly
 * @param pageData a page with its front matter collected
 * @param {FileConfig} fileConfig
 */
 insertHeaderFile(pageData) {
 insertHeaderFile(pageData, fileConfig) {
 const { header } = this.frontMatter;
 if (header === FRONT_MATTER_NONE_ATTR) {
 return pageData;
Expand All@@ -624,6 +632,13 @@ class Page {
 }
 // Retrieve Markdown file contents
 const headerContent = fs.readFileSync(headerPath, 'utf8');
 // Decide if fixed header is applied
 const headerSelector = cheerio.load(headerContent)('header');
 if (headerSelector.length >= 1
 && headerSelector[0].attribs.fixed !== undefined) {
 this.fixedHeader = true;
 fileConfig.fixedHeader = true;
 }
 // Set header file as an includedFile
 this.includedFiles.add(headerPath);
 // Map variables
Expand DownExpand Up@@ -894,6 +909,7 @@ class Page {
 * @property {string} rootPath
 * @property {Object<string, any>} userDefinedVariablesMap
 * @property {Object<string, number>} headerIdMap
 * @property {boolean} fixedHeader indicates whether the header of the page is fixed
 */

 generate(builtFiles) {
Expand All@@ -911,6 +927,7 @@ class Page {
 rootPath: this.rootPath,
 userDefinedVariablesMap: this.userDefinedVariablesMap,
 headerIdMap: this.headerIdMap,
 fixedHeader: this.fixedHeader,
 };
 return new Promise((resolve, reject) => {
 markbinder.includeFile(this.sourcePath, fileConfig)
Expand All@@ -924,7 +941,7 @@ class Page {
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
 .then(result => this.insertHeaderFile(result, fileConfig))
 .then(result => this.insertFooterFile(result))
 .then(result => Page.insertTemporaryStyles(result))
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
Expand Down

9 changes: 8 additions & 1 deletion
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -292,7 +292,9 @@ class Parser {
 node.name = node.name.toLowerCase();
 }

 if ((/^h[1-6]$/).test(node.name) && !node.attribs.id) {
 const isHeadingTag = (/^h[1-6]$/).test(node.name);

 if (isHeadingTag && !node.attribs.id) {
 const textContent = utils.getTextContent(node);
 // remove the '&lt;' and '&gt;' symbols that markdown-it uses to escape '<' and '>'
 const cleanedContent = textContent.replace(/&lt;|&gt;/g, '');
Expand DownExpand Up@@ -353,6 +355,11 @@ class Parser {

 componentParser.postParseComponents(node, this._onError);

 // If a fixed header is applied to this page, generate dummy spans as anchor points
 if (config.fixedHeader && isHeadingTag && node.attribs.id) {
 cheerio(node).append(cheerio.parseHTML(`<span id="${node.attribs.id}" class="anchor"></span>`));
 }

 return node;
 }

Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_algolia_plugin/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_algolia_plugin/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_convert/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_convert/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_expressive_layout/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_expressive_layout/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_special_tags/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[v2] Fix anchor navigation in panel headers by le0tan · Pull Request #1191 · MarkBind/markbind · GitHub
Skip to content
[v2] Fix anchor navigation in panel headers#1191

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

le0tan
merged 6 commits into

from

Apr 15, 2020
 Merged


[v2] Fix anchor navigation in panel headers
#1191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fad6f5b

Integrate the plugin as part of MarkBind


le0tan Apr 11, 2020
58ddd5e

Resolve comments


le0tan Apr 11, 2020
6bdb2dd

Update documentation and remove unnecessary code


le0tan Apr 12, 2020
a594505

Merge remote-tracking branch 'upstream/master' into issue-1104-v4


le0tan Apr 12, 2020
87183c2

Use fixed attr instead of class="fixed-header"


le0tan Apr 14, 2020
a98624e

Add additional offset for .nav-inner


le0tan Apr 15, 2020

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


2 changes: 1 addition & 1 deletion
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
@ang-zeyuang-zeyuApr 12, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

would it be possible to just insert the padding for the main container and not its 3 sub containers?
fixedheader
@le0tanle0tanApr 14, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As far as I'm concerned it doesn't work...
@ang-zeyuang-zeyuApr 14, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

ok, might be better to leave it this way as well: .css('nav-inner') needs to be offsetted with the original padding
navbarpadding
@le0tanle0tanApr 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

just did that, wondering if we need to add 1rem to content-wrapper as well, but probably better leave it as a future first timer issue?
@ang-zeyuang-zeyuApr 15, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Good idea, would make it seem less squeezed to the top. Let's leave it as a first timer issue then, though if you want to include it here it'd be nice as well
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/headers/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/devGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/userGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

11 changes: 11 additions & 0 deletions
docs/userGuide/syntax/headers.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,17 @@ In the page that you want to include the header:
```
</div>

You can fix the header to be always on the top by add `fixed` attribute to the `<header>` tag of your header file:

{{ icon_example }}
**`_markbind/headers/`**`header.md`:
Comment thread
le0tan marked this conversation as resolved.

```html
<header fixed>
 <!--Normal header stuff goes here-->
</header>

```

Notes:
- Any inline headers will be removed by MarkBind to ensure compatibility with header files.
- If a [Layout]({{ baseUrl }}/userGuide/tweakingThePageStructure.html#page-layouts) is specified, the header file specified in the `<frontmatter>` will override the header within the Layout.
Expand Down

21 changes: 19 additions & 2 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ class Page {
 * @type {boolean}
 */
 this.hasSiteNav = false;

 /**
 * Flag to indicate whether a fixed header is enabled.
 * @type {boolean}
 */
 this.fixedHeader = false;
 }

 /**
Expand DownExpand Up@@ -604,9 +610,11 @@ class Page {

 /**
 * Inserts the page layout's header to the start of the page
 * Determines if a fixed header is present, update the page config accordingly
 * @param pageData a page with its front matter collected
 * @param {FileConfig} fileConfig
 */
 insertHeaderFile(pageData) {
 insertHeaderFile(pageData, fileConfig) {
 const { header } = this.frontMatter;
 if (header === FRONT_MATTER_NONE_ATTR) {
 return pageData;
Expand All@@ -624,6 +632,13 @@ class Page {
 }
 // Retrieve Markdown file contents
 const headerContent = fs.readFileSync(headerPath, 'utf8');
 // Decide if fixed header is applied
 const headerSelector = cheerio.load(headerContent)('header');
 if (headerSelector.length >= 1
 && headerSelector[0].attribs.fixed !== undefined) {
 this.fixedHeader = true;
 fileConfig.fixedHeader = true;
 }
 // Set header file as an includedFile
 this.includedFiles.add(headerPath);
 // Map variables
Expand DownExpand Up@@ -894,6 +909,7 @@ class Page {
 * @property {string} rootPath
 * @property {Object<string, any>} userDefinedVariablesMap
 * @property {Object<string, number>} headerIdMap
 * @property {boolean} fixedHeader indicates whether the header of the page is fixed
 */

 generate(builtFiles) {
Expand All@@ -911,6 +927,7 @@ class Page {
 rootPath: this.rootPath,
 userDefinedVariablesMap: this.userDefinedVariablesMap,
 headerIdMap: this.headerIdMap,
 fixedHeader: this.fixedHeader,
 };
 return new Promise((resolve, reject) => {
 markbinder.includeFile(this.sourcePath, fileConfig)
Expand All@@ -924,7 +941,7 @@ class Page {
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
 .then(result => this.insertHeaderFile(result, fileConfig))
 .then(result => this.insertFooterFile(result))
 .then(result => Page.insertTemporaryStyles(result))
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
Expand Down

9 changes: 8 additions & 1 deletion
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -292,7 +292,9 @@ class Parser {
 node.name = node.name.toLowerCase();
 }

 if ((/^h[1-6]$/).test(node.name) && !node.attribs.id) {
 const isHeadingTag = (/^h[1-6]$/).test(node.name);

 if (isHeadingTag && !node.attribs.id) {
 const textContent = utils.getTextContent(node);
 // remove the '&lt;' and '&gt;' symbols that markdown-it uses to escape '<' and '>'
 const cleanedContent = textContent.replace(/&lt;|&gt;/g, '');
Expand DownExpand Up@@ -353,6 +355,11 @@ class Parser {

 componentParser.postParseComponents(node, this._onError);

 // If a fixed header is applied to this page, generate dummy spans as anchor points
 if (config.fixedHeader && isHeadingTag && node.attribs.id) {
 cheerio(node).append(cheerio.parseHTML(`<span id="${node.attribs.id}" class="anchor"></span>`));
 }

 return node;
 }

Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_algolia_plugin/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_algolia_plugin/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_convert/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_convert/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_expressive_layout/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_expressive_layout/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_special_tags/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[v2] Fix anchor navigation in panel headers by le0tan · Pull Request #1191 · MarkBind/markbind · GitHub
Skip to content
[v2] Fix anchor navigation in panel headers#1191

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

le0tan
merged 6 commits into

from

Apr 15, 2020
 Merged


[v2] Fix anchor navigation in panel headers
#1191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fad6f5b

Integrate the plugin as part of MarkBind


le0tan Apr 11, 2020
58ddd5e

Resolve comments


le0tan Apr 11, 2020
6bdb2dd

Update documentation and remove unnecessary code


le0tan Apr 12, 2020
a594505

Merge remote-tracking branch 'upstream/master' into issue-1104-v4


le0tan Apr 12, 2020
87183c2

Use fixed attr instead of class="fixed-header"


le0tan Apr 14, 2020
a98624e

Add additional offset for .nav-inner


le0tan Apr 15, 2020

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


2 changes: 1 addition & 1 deletion
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
@ang-zeyuang-zeyuApr 12, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

would it be possible to just insert the padding for the main container and not its 3 sub containers?
fixedheader
@le0tanle0tanApr 14, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As far as I'm concerned it doesn't work...
@ang-zeyuang-zeyuApr 14, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

ok, might be better to leave it this way as well: .css('nav-inner') needs to be offsetted with the original padding
navbarpadding
@le0tanle0tanApr 15, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

just did that, wondering if we need to add 1rem to content-wrapper as well, but probably better leave it as a future first timer issue?
@ang-zeyuang-zeyuApr 15, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Good idea, would make it seem less squeezed to the top. Let's leave it as a first timer issue then, though if you want to include it here it'd be nice as well
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/headers/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/devGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

2 changes: 1 addition & 1 deletion
docs/_markbind/layouts/userGuide/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
<header>
<header fixed>
 <link rel="stylesheet" href="{{baseUrl}}/css/main.css">
 <navbar type="dark">
 <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
Expand Down

11 changes: 11 additions & 0 deletions
docs/userGuide/syntax/headers.mbdf

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,17 @@ In the page that you want to include the header:
```
</div>

You can fix the header to be always on the top by add `fixed` attribute to the `<header>` tag of your header file:

{{ icon_example }}
**`_markbind/headers/`**`header.md`:
Comment thread
le0tan marked this conversation as resolved.

```html
<header fixed>
 <!--Normal header stuff goes here-->
</header>

```

Notes:
- Any inline headers will be removed by MarkBind to ensure compatibility with header files.
- If a [Layout]({{ baseUrl }}/userGuide/tweakingThePageStructure.html#page-layouts) is specified, the header file specified in the `<frontmatter>` will override the header within the Layout.
Expand Down

21 changes: 19 additions & 2 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ class Page {
 * @type {boolean}
 */
 this.hasSiteNav = false;

 /**
 * Flag to indicate whether a fixed header is enabled.
 * @type {boolean}
 */
 this.fixedHeader = false;
 }

 /**
Expand DownExpand Up@@ -604,9 +610,11 @@ class Page {

 /**
 * Inserts the page layout's header to the start of the page
 * Determines if a fixed header is present, update the page config accordingly
 * @param pageData a page with its front matter collected
 * @param {FileConfig} fileConfig
 */
 insertHeaderFile(pageData) {
 insertHeaderFile(pageData, fileConfig) {
 const { header } = this.frontMatter;
 if (header === FRONT_MATTER_NONE_ATTR) {
 return pageData;
Expand All@@ -624,6 +632,13 @@ class Page {
 }
 // Retrieve Markdown file contents
 const headerContent = fs.readFileSync(headerPath, 'utf8');
 // Decide if fixed header is applied
 const headerSelector = cheerio.load(headerContent)('header');
 if (headerSelector.length >= 1
 && headerSelector[0].attribs.fixed !== undefined) {
 this.fixedHeader = true;
 fileConfig.fixedHeader = true;
 }
 // Set header file as an includedFile
 this.includedFiles.add(headerPath);
 // Map variables
Expand DownExpand Up@@ -894,6 +909,7 @@ class Page {
 * @property {string} rootPath
 * @property {Object<string, any>} userDefinedVariablesMap
 * @property {Object<string, number>} headerIdMap
 * @property {boolean} fixedHeader indicates whether the header of the page is fixed
 */

 generate(builtFiles) {
Expand All@@ -911,6 +927,7 @@ class Page {
 rootPath: this.rootPath,
 userDefinedVariablesMap: this.userDefinedVariablesMap,
 headerIdMap: this.headerIdMap,
 fixedHeader: this.fixedHeader,
 };
 return new Promise((resolve, reject) => {
 markbinder.includeFile(this.sourcePath, fileConfig)
Expand All@@ -924,7 +941,7 @@ class Page {
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
 .then(result => this.insertHeaderFile(result, fileConfig))
 .then(result => this.insertFooterFile(result))
 .then(result => Page.insertTemporaryStyles(result))
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
Expand Down

9 changes: 8 additions & 1 deletion
src/lib/markbind/src/parser.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -292,7 +292,9 @@ class Parser {
 node.name = node.name.toLowerCase();
 }

 if ((/^h[1-6]$/).test(node.name) && !node.attribs.id) {
 const isHeadingTag = (/^h[1-6]$/).test(node.name);

 if (isHeadingTag && !node.attribs.id) {
 const textContent = utils.getTextContent(node);
 // remove the '&lt;' and '&gt;' symbols that markdown-it uses to escape '<' and '>'
 const cleanedContent = textContent.replace(/&lt;|&gt;/g, '');
Expand DownExpand Up@@ -353,6 +355,11 @@ class Parser {

 componentParser.postParseComponents(node, this._onError);

 // If a fixed header is applied to this page, generate dummy spans as anchor points
 if (config.fixedHeader && isHeadingTag && node.attribs.id) {
 cheerio(node).append(cheerio.parseHTML(`<span id="${node.attribs.id}" class="anchor"></span>`));
 }

 return node;
 }

Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_algolia_plugin/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_algolia_plugin/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_convert/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_convert/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_expressive_layout/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down

20 changes: 9 additions & 11 deletions
test/functional/test_site_expressive_layout/expected/markbind/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,32 +20,30 @@ function insertCss(cssCode) {
}

function setupAnchorsForFixedNavbar() {
 const headerSelector = jQuery('header');
 const isFixed = headerSelector.filter('.header-fixed').length !== 0;
 const headerSelector = jQuery('header[fixed]');
 const isFixed = headerSelector.length !== 0;
 if (!isFixed) {
 return;
 }

 const headerHeight = headerSelector.height();
 const bufferHeight = 1;
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px)`);
 jQuery('.nav-inner').css('padding-top', `calc(${headerHeight}px + 1rem)`);
 jQuery('#content-wrapper').css('padding-top', `calc(${headerHeight}px)`);
 insertCss(
 `span.anchor {
 display: block;
 position: relative;
 top: calc(-${headerHeight}px - ${bufferHeight}rem)
 }`,
 );
 insertCss(`span.card-container::before {
 display: block;
 content: '';
 margin-top: calc(-${headerHeight}px - ${bufferHeight}rem);
 height: calc(${headerHeight}px + ${bufferHeight}rem);
 }`);
 jQuery('h1, h2, h3, h4, h5, h6, .header-wrapper').each((index, heading) => {
 if (heading.id) {
 /**
 * Fixing the top navbar would break anchor navigation,
 * by creating empty spans above the <h> tag we can prevent
 * the headings from being covered by the navbar.
 */
 const spanId = heading.id;
 heading.insertAdjacentHTML('beforebegin', `<span id="${spanId}" class="anchor"></span>`);
 jQuery(heading).removeAttr('id'); // to avoid duplicated id problem
 }
 });
Expand Down

2 changes: 1 addition & 1 deletion
test/functional/test_site_special_tags/expected/markbind/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ code.hljs:hover {

/* Header */

header.header-fixed {
header[fixed] {
 position: fixed;
 width: 100%;
 z-index: 1000;
Expand Down
Loading