Skip to content

Show anchor links for each heading#433

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
yamgent merged 1 commit into from
Sep 28, 2018
Merged

Show anchor links for each heading #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions asset/css/markbind.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,19 @@ pre > code.hljs {
outline: none !important;
}

.fa.fa-anchor {
color: #ccc;
display: none;
font-size: 14px;
margin-left: 10px;
padding: 3px;
text-decoration: none;
}

.fa.fa-anchor:hover {
color: #555;
}

.markbind-table {
width: auto;
}
Expand Down
12 changes: 12 additions & 0 deletions asset/js/setup.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,21 @@ function flattenModals() {
});
}

function setupAnchorVisibility() {
jQuery('h1, h2, h3, h4, h5, h6').each((index, heading) => {
jQuery(heading).on('mouseenter', function () {
jQuery(this).children('.fa.fa-anchor').show();
});
jQuery(heading).on('mouseleave', function () {
jQuery(this).children('.fa.fa-anchor').hide();
});
});
}

function executeAfterMountedRoutines() {
flattenModals();
scrollToUrlAnchorHeading();
setupAnchorVisibility();
Comment thread
jamos-tay marked this conversation as resolved.
}

function setupSiteNav() {
Expand Down
10 changes: 9 additions & 1 deletion docs/userGuide/contentAuthoring.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -589,4 +589,12 @@ Note:
- Footers should not be nested in other components or HTML tags. If found inside, they will be shifted outside to be rendered properly.
- [MarkBind components](#use-components) and [includes](#include-contents) are not supported in footers.

</div>
### Heading Anchors

Your site's readers may want to obtain a link to a heading within a page, to share with someone else for example.

MarkBind automatically generates heading anchors for your page.

When the reader hovers over a heading in your page, a small anchor icon <i class="fas fa-anchor"></i> will become visible next to the heading. Clicking this icon will redirect the page to that heading, producing the desired URL in the URL bar that the reader can share with someone else. Try it with the headings on this page!

</div>
34 changes: 30 additions & 4 deletions lib/Page.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ const PAGE_CONTENT_ID = 'page-content';
const SITE_NAV_ID = 'site-nav';
const TITLE_PREFIX_SEPARATOR = ' - ';

const ANCHOR_HTML = '<a class="fa fa-anchor" href="#"></a>';
const DROPDOWN_BUTTON_ICON_HTML = '<i class="dropdown-btn-icon">\n'
+ '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
+ '</i>';
Expand DownExpand Up@@ -219,16 +220,25 @@ Page.prototype.collectHeadingsAndKeywords = function () {
this.collectHeadingsAndKeywordsInContent($(`#${CONTENT_WRAPPER_ID}`).html(), null);
};

/**
* Generates a heading selector based on the indexing level
* @param headingIndexingLevel to generate
*/
function generateHeadingSelector(headingIndexingLevel) {
let headingsSelector = 'h1';
for (let i = 2; i <= headingIndexingLevel; i += 1) {
headingsSelector += `, h${i}`;
}
return headingsSelector;
}

/**
* Records headings and keywords inside content into this.headings and this.keywords respectively
* @param content that contains the headings and keywords
*/
Page.prototype.collectHeadingsAndKeywordsInContent = function (content, lastHeading) {
let $ = cheerio.load(content);
let headingsSelector = 'h1';
for (let i = 2; i <= this.headingIndexingLevel; i += 1) {
headingsSelector += `, h${i}`;
}
const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
$('modal').remove();
$('panel').not('panel panel')
.each((index, panel) => {
Expand DownExpand Up@@ -309,6 +319,21 @@ Page.prototype.concatenateHeadingsAndKeywords = function () {
});
};

/**
* Adds anchor links to headings in the page
* @param content of the page
*/
Page.prototype.addAnchors = function (content) {
const $ = cheerio.load(content, { xmlMode: false });
if (this.headingIndexingLevel > 0) {
const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
$(headingsSelector).each((i, heading) => {
$(heading).append(ANCHOR_HTML.replace('#', `#${$(heading).attr('id')}`));
});
}
return $.html();
};

/**
* Records the dynamic or static included files into this.includedFiles
* @param dependencies array of maps of the external dependency and where it is included
Expand DownExpand Up@@ -471,6 +496,7 @@ Page.prototype.generate = function (builtFiles) {
.then(result => markbinder.resolveBaseUrl(result, fileConfig))
.then(result => fs.outputFileAsync(this.tempPath, result))
.then(() => markbinder.renderFile(this.tempPath, fileConfig))
.then(result => this.addAnchors(result))
.then((result) => {
this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down
6 changes: 3 additions & 3 deletions test/test_site/expected/bugs/index.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
</navbar>
</div>
<div class="website-content">
<h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute</h2>
<h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute<a class="fa fa-anchor" href="#popover-initiated-by-trigger-honor-trigger-attribute"></a></h2>
<p><a href="https://github.com/MarkBind/markbind/issues/49">Issue #49</a></p>
<p>Repro:</p>
<p>
Expand All@@ -40,7 +40,7 @@ <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated
</div>
</div>
</popover>
<h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal</h2>
<h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal<a class="fa fa-anchor" href="#support-multiple-inclusions-of-a-modal"></a></h2>
<p><a href="https://github.com/MarkBind/markbind/issues/107">Issue #107</a></p>
<p>Repro:</p>
<div>
Expand All@@ -65,7 +65,7 @@ <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a
</div>
</modal>
</div>
<h2 id="remove-extra-space-in-links">Remove extra space in links</h2>
<h2 id="remove-extra-space-in-links">Remove extra space in links<a class="fa fa-anchor" href="#remove-extra-space-in-links"></a></h2>
<p><a href="https://github.com/MarkBind/markbind/issues/147">Issue #147</a></p>
<p>Repro:</p>
<p>This is a link. [
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" + '
Show anchor links for each heading by jamos-tay · Pull Request #433 · MarkBind/markbind · GitHub
Skip to content
Show anchor links for each heading#433

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

yamgent
merged 1 commit into

from

Sep 28, 2018
 Merged


Show anchor links for each heading
#433
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


13 changes: 13 additions & 0 deletions
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,19 @@ pre > code.hljs {
 outline: none !important;
}

.fa.fa-anchor {
 color: #ccc;
 display: none;
 font-size: 14px;
 margin-left: 10px;
 padding: 3px;
 text-decoration: none;
}

.fa.fa-anchor:hover {
 color: #555;
}

.markbind-table {
 width: auto;
}
Expand Down

12 changes: 12 additions & 0 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,21 @@ function flattenModals() {
 });
}

function setupAnchorVisibility() {
 jQuery('h1, h2, h3, h4, h5, h6').each((index, heading) => {
 jQuery(heading).on('mouseenter', function () {
 jQuery(this).children('.fa.fa-anchor').show();
 });
 jQuery(heading).on('mouseleave', function () {
 jQuery(this).children('.fa.fa-anchor').hide();
 });
 });
}

function executeAfterMountedRoutines() {
 flattenModals();
 scrollToUrlAnchorHeading();
 setupAnchorVisibility();
Comment thread
jamos-tay marked this conversation as resolved.

}

function setupSiteNav() {
Expand Down

10 changes: 9 additions & 1 deletion
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -589,4 +589,12 @@ Note:
- Footers should not be nested in other components or HTML tags. If found inside, they will be shifted outside to be rendered properly.
- [MarkBind components](#use-components) and [includes](#include-contents) are not supported in footers.

</div>
### Heading Anchors

Your site's readers may want to obtain a link to a heading within a page, to share with someone else for example.

MarkBind automatically generates heading anchors for your page.

When the reader hovers over a heading in your page, a small anchor icon <i class="fas fa-anchor"></i> will become visible next to the heading. Clicking this icon will redirect the page to that heading, producing the desired URL in the URL bar that the reader can share with someone else. Try it with the headings on this page!

</div>

34 changes: 30 additions & 4 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ const PAGE_CONTENT_ID = 'page-content';
const SITE_NAV_ID = 'site-nav';
const TITLE_PREFIX_SEPARATOR = ' - ';

const ANCHOR_HTML = '<a class="fa fa-anchor" href="#"></a>';
const DROPDOWN_BUTTON_ICON_HTML = '<i class="dropdown-btn-icon">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
Expand DownExpand Up@@ -219,16 +220,25 @@ Page.prototype.collectHeadingsAndKeywords = function () {
 this.collectHeadingsAndKeywordsInContent($(`#${CONTENT_WRAPPER_ID}`).html(), null);
};

/**
 * Generates a heading selector based on the indexing level
 * @param headingIndexingLevel to generate
 */
function generateHeadingSelector(headingIndexingLevel) {
 let headingsSelector = 'h1';
 for (let i = 2; i <= headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 return headingsSelector;
}

/**
 * Records headings and keywords inside content into this.headings and this.keywords respectively
 * @param content that contains the headings and keywords
 */
Page.prototype.collectHeadingsAndKeywordsInContent = function (content, lastHeading) {
 let $ = cheerio.load(content);
 let headingsSelector = 'h1';
 for (let i = 2; i <= this.headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $('modal').remove();
 $('panel').not('panel panel')
 .each((index, panel) => {
Expand DownExpand Up@@ -309,6 +319,21 @@ Page.prototype.concatenateHeadingsAndKeywords = function () {
 });
};

/**
 * Adds anchor links to headings in the page
 * @param content of the page
 */
Page.prototype.addAnchors = function (content) {
 const $ = cheerio.load(content, { xmlMode: false });
 if (this.headingIndexingLevel > 0) {
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $(headingsSelector).each((i, heading) => {
 $(heading).append(ANCHOR_HTML.replace('#', `#${$(heading).attr('id')}`));
 });
 }
 return $.html();
};

/**
 * Records the dynamic or static included files into this.includedFiles
 * @param dependencies array of maps of the external dependency and where it is included
Expand DownExpand Up@@ -471,6 +496,7 @@ Page.prototype.generate = function (builtFiles) {
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
 .then(result => fs.outputFileAsync(this.tempPath, result))
 .then(() => markbinder.renderFile(this.tempPath, fileConfig))
 .then(result => this.addAnchors(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

6 changes: 3 additions & 3 deletions
test/test_site/expected/bugs/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 </navbar>
 </div>
 <div class="website-content">
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute</h2>
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute<a class="fa fa-anchor" href="#popover-initiated-by-trigger-honor-trigger-attribute"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/49">Issue #49</a></p>
 <p>Repro:</p>
 <p>
Expand All@@ -40,7 +40,7 @@ <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated
 </div>
 </div>
 </popover>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal</h2>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal<a class="fa fa-anchor" href="#support-multiple-inclusions-of-a-modal"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/107">Issue #107</a></p>
 <p>Repro:</p>
 <div>
Expand All@@ -65,7 +65,7 @@ <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a
 </div>
 </modal>
 </div>
 <h2 id="remove-extra-space-in-links">Remove extra space in links</h2>
 <h2 id="remove-extra-space-in-links">Remove extra space in links<a class="fa fa-anchor" href="#remove-extra-space-in-links"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/147">Issue #147</a></p>
 <p>Repro:</p>
 <p>This is a link. [
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('^' + ".*" + '
Show anchor links for each heading by jamos-tay · Pull Request #433 · MarkBind/markbind · GitHub
Skip to content
Show anchor links for each heading#433

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

yamgent
merged 1 commit into

from

Sep 28, 2018
 Merged


Show anchor links for each heading
#433
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


13 changes: 13 additions & 0 deletions
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,19 @@ pre > code.hljs {
 outline: none !important;
}

.fa.fa-anchor {
 color: #ccc;
 display: none;
 font-size: 14px;
 margin-left: 10px;
 padding: 3px;
 text-decoration: none;
}

.fa.fa-anchor:hover {
 color: #555;
}

.markbind-table {
 width: auto;
}
Expand Down

12 changes: 12 additions & 0 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,21 @@ function flattenModals() {
 });
}

function setupAnchorVisibility() {
 jQuery('h1, h2, h3, h4, h5, h6').each((index, heading) => {
 jQuery(heading).on('mouseenter', function () {
 jQuery(this).children('.fa.fa-anchor').show();
 });
 jQuery(heading).on('mouseleave', function () {
 jQuery(this).children('.fa.fa-anchor').hide();
 });
 });
}

function executeAfterMountedRoutines() {
 flattenModals();
 scrollToUrlAnchorHeading();
 setupAnchorVisibility();
Comment thread
jamos-tay marked this conversation as resolved.

}

function setupSiteNav() {
Expand Down

10 changes: 9 additions & 1 deletion
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -589,4 +589,12 @@ Note:
- Footers should not be nested in other components or HTML tags. If found inside, they will be shifted outside to be rendered properly.
- [MarkBind components](#use-components) and [includes](#include-contents) are not supported in footers.

</div>
### Heading Anchors

Your site's readers may want to obtain a link to a heading within a page, to share with someone else for example.

MarkBind automatically generates heading anchors for your page.

When the reader hovers over a heading in your page, a small anchor icon <i class="fas fa-anchor"></i> will become visible next to the heading. Clicking this icon will redirect the page to that heading, producing the desired URL in the URL bar that the reader can share with someone else. Try it with the headings on this page!

</div>

34 changes: 30 additions & 4 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ const PAGE_CONTENT_ID = 'page-content';
const SITE_NAV_ID = 'site-nav';
const TITLE_PREFIX_SEPARATOR = ' - ';

const ANCHOR_HTML = '<a class="fa fa-anchor" href="#"></a>';
const DROPDOWN_BUTTON_ICON_HTML = '<i class="dropdown-btn-icon">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
Expand DownExpand Up@@ -219,16 +220,25 @@ Page.prototype.collectHeadingsAndKeywords = function () {
 this.collectHeadingsAndKeywordsInContent($(`#${CONTENT_WRAPPER_ID}`).html(), null);
};

/**
 * Generates a heading selector based on the indexing level
 * @param headingIndexingLevel to generate
 */
function generateHeadingSelector(headingIndexingLevel) {
 let headingsSelector = 'h1';
 for (let i = 2; i <= headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 return headingsSelector;
}

/**
 * Records headings and keywords inside content into this.headings and this.keywords respectively
 * @param content that contains the headings and keywords
 */
Page.prototype.collectHeadingsAndKeywordsInContent = function (content, lastHeading) {
 let $ = cheerio.load(content);
 let headingsSelector = 'h1';
 for (let i = 2; i <= this.headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $('modal').remove();
 $('panel').not('panel panel')
 .each((index, panel) => {
Expand DownExpand Up@@ -309,6 +319,21 @@ Page.prototype.concatenateHeadingsAndKeywords = function () {
 });
};

/**
 * Adds anchor links to headings in the page
 * @param content of the page
 */
Page.prototype.addAnchors = function (content) {
 const $ = cheerio.load(content, { xmlMode: false });
 if (this.headingIndexingLevel > 0) {
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $(headingsSelector).each((i, heading) => {
 $(heading).append(ANCHOR_HTML.replace('#', `#${$(heading).attr('id')}`));
 });
 }
 return $.html();
};

/**
 * Records the dynamic or static included files into this.includedFiles
 * @param dependencies array of maps of the external dependency and where it is included
Expand DownExpand Up@@ -471,6 +496,7 @@ Page.prototype.generate = function (builtFiles) {
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
 .then(result => fs.outputFileAsync(this.tempPath, result))
 .then(() => markbinder.renderFile(this.tempPath, fileConfig))
 .then(result => this.addAnchors(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

6 changes: 3 additions & 3 deletions
test/test_site/expected/bugs/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 </navbar>
 </div>
 <div class="website-content">
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute</h2>
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute<a class="fa fa-anchor" href="#popover-initiated-by-trigger-honor-trigger-attribute"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/49">Issue #49</a></p>
 <p>Repro:</p>
 <p>
Expand All@@ -40,7 +40,7 @@ <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated
 </div>
 </div>
 </popover>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal</h2>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal<a class="fa fa-anchor" href="#support-multiple-inclusions-of-a-modal"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/107">Issue #107</a></p>
 <p>Repro:</p>
 <div>
Expand All@@ -65,7 +65,7 @@ <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a
 </div>
 </modal>
 </div>
 <h2 id="remove-extra-space-in-links">Remove extra space in links</h2>
 <h2 id="remove-extra-space-in-links">Remove extra space in links<a class="fa fa-anchor" href="#remove-extra-space-in-links"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/147">Issue #147</a></p>
 <p>Repro:</p>
 <p>This is a link. [
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('^' + ".*" + '
Show anchor links for each heading by jamos-tay · Pull Request #433 · MarkBind/markbind · GitHub
Skip to content
Show anchor links for each heading#433

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

yamgent
merged 1 commit into

from

Sep 28, 2018
 Merged


Show anchor links for each heading
#433
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


13 changes: 13 additions & 0 deletions
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,19 @@ pre > code.hljs {
 outline: none !important;
}

.fa.fa-anchor {
 color: #ccc;
 display: none;
 font-size: 14px;
 margin-left: 10px;
 padding: 3px;
 text-decoration: none;
}

.fa.fa-anchor:hover {
 color: #555;
}

.markbind-table {
 width: auto;
}
Expand Down

12 changes: 12 additions & 0 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,21 @@ function flattenModals() {
 });
}

function setupAnchorVisibility() {
 jQuery('h1, h2, h3, h4, h5, h6').each((index, heading) => {
 jQuery(heading).on('mouseenter', function () {
 jQuery(this).children('.fa.fa-anchor').show();
 });
 jQuery(heading).on('mouseleave', function () {
 jQuery(this).children('.fa.fa-anchor').hide();
 });
 });
}

function executeAfterMountedRoutines() {
 flattenModals();
 scrollToUrlAnchorHeading();
 setupAnchorVisibility();
Comment thread
jamos-tay marked this conversation as resolved.

}

function setupSiteNav() {
Expand Down

10 changes: 9 additions & 1 deletion
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -589,4 +589,12 @@ Note:
- Footers should not be nested in other components or HTML tags. If found inside, they will be shifted outside to be rendered properly.
- [MarkBind components](#use-components) and [includes](#include-contents) are not supported in footers.

</div>
### Heading Anchors

Your site's readers may want to obtain a link to a heading within a page, to share with someone else for example.

MarkBind automatically generates heading anchors for your page.

When the reader hovers over a heading in your page, a small anchor icon <i class="fas fa-anchor"></i> will become visible next to the heading. Clicking this icon will redirect the page to that heading, producing the desired URL in the URL bar that the reader can share with someone else. Try it with the headings on this page!

</div>

34 changes: 30 additions & 4 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ const PAGE_CONTENT_ID = 'page-content';
const SITE_NAV_ID = 'site-nav';
const TITLE_PREFIX_SEPARATOR = ' - ';

const ANCHOR_HTML = '<a class="fa fa-anchor" href="#"></a>';
const DROPDOWN_BUTTON_ICON_HTML = '<i class="dropdown-btn-icon">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
Expand DownExpand Up@@ -219,16 +220,25 @@ Page.prototype.collectHeadingsAndKeywords = function () {
 this.collectHeadingsAndKeywordsInContent($(`#${CONTENT_WRAPPER_ID}`).html(), null);
};

/**
 * Generates a heading selector based on the indexing level
 * @param headingIndexingLevel to generate
 */
function generateHeadingSelector(headingIndexingLevel) {
 let headingsSelector = 'h1';
 for (let i = 2; i <= headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 return headingsSelector;
}

/**
 * Records headings and keywords inside content into this.headings and this.keywords respectively
 * @param content that contains the headings and keywords
 */
Page.prototype.collectHeadingsAndKeywordsInContent = function (content, lastHeading) {
 let $ = cheerio.load(content);
 let headingsSelector = 'h1';
 for (let i = 2; i <= this.headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $('modal').remove();
 $('panel').not('panel panel')
 .each((index, panel) => {
Expand DownExpand Up@@ -309,6 +319,21 @@ Page.prototype.concatenateHeadingsAndKeywords = function () {
 });
};

/**
 * Adds anchor links to headings in the page
 * @param content of the page
 */
Page.prototype.addAnchors = function (content) {
 const $ = cheerio.load(content, { xmlMode: false });
 if (this.headingIndexingLevel > 0) {
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $(headingsSelector).each((i, heading) => {
 $(heading).append(ANCHOR_HTML.replace('#', `#${$(heading).attr('id')}`));
 });
 }
 return $.html();
};

/**
 * Records the dynamic or static included files into this.includedFiles
 * @param dependencies array of maps of the external dependency and where it is included
Expand DownExpand Up@@ -471,6 +496,7 @@ Page.prototype.generate = function (builtFiles) {
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
 .then(result => fs.outputFileAsync(this.tempPath, result))
 .then(() => markbinder.renderFile(this.tempPath, fileConfig))
 .then(result => this.addAnchors(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

6 changes: 3 additions & 3 deletions
test/test_site/expected/bugs/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 </navbar>
 </div>
 <div class="website-content">
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute</h2>
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute<a class="fa fa-anchor" href="#popover-initiated-by-trigger-honor-trigger-attribute"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/49">Issue #49</a></p>
 <p>Repro:</p>
 <p>
Expand All@@ -40,7 +40,7 @@ <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated
 </div>
 </div>
 </popover>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal</h2>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal<a class="fa fa-anchor" href="#support-multiple-inclusions-of-a-modal"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/107">Issue #107</a></p>
 <p>Repro:</p>
 <div>
Expand All@@ -65,7 +65,7 @@ <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a
 </div>
 </modal>
 </div>
 <h2 id="remove-extra-space-in-links">Remove extra space in links</h2>
 <h2 id="remove-extra-space-in-links">Remove extra space in links<a class="fa fa-anchor" href="#remove-extra-space-in-links"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/147">Issue #147</a></p>
 <p>Repro:</p>
 <p>This is a link. [
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" + '
Show anchor links for each heading by jamos-tay · Pull Request #433 · MarkBind/markbind · GitHub
Skip to content
Show anchor links for each heading#433

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

yamgent
merged 1 commit into

from

Sep 28, 2018
 Merged


Show anchor links for each heading
#433
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


13 changes: 13 additions & 0 deletions
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,19 @@ pre > code.hljs {
 outline: none !important;
}

.fa.fa-anchor {
 color: #ccc;
 display: none;
 font-size: 14px;
 margin-left: 10px;
 padding: 3px;
 text-decoration: none;
}

.fa.fa-anchor:hover {
 color: #555;
}

.markbind-table {
 width: auto;
}
Expand Down

12 changes: 12 additions & 0 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,21 @@ function flattenModals() {
 });
}

function setupAnchorVisibility() {
 jQuery('h1, h2, h3, h4, h5, h6').each((index, heading) => {
 jQuery(heading).on('mouseenter', function () {
 jQuery(this).children('.fa.fa-anchor').show();
 });
 jQuery(heading).on('mouseleave', function () {
 jQuery(this).children('.fa.fa-anchor').hide();
 });
 });
}

function executeAfterMountedRoutines() {
 flattenModals();
 scrollToUrlAnchorHeading();
 setupAnchorVisibility();
Comment thread
jamos-tay marked this conversation as resolved.

}

function setupSiteNav() {
Expand Down

10 changes: 9 additions & 1 deletion
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -589,4 +589,12 @@ Note:
- Footers should not be nested in other components or HTML tags. If found inside, they will be shifted outside to be rendered properly.
- [MarkBind components](#use-components) and [includes](#include-contents) are not supported in footers.

</div>
### Heading Anchors

Your site's readers may want to obtain a link to a heading within a page, to share with someone else for example.

MarkBind automatically generates heading anchors for your page.

When the reader hovers over a heading in your page, a small anchor icon <i class="fas fa-anchor"></i> will become visible next to the heading. Clicking this icon will redirect the page to that heading, producing the desired URL in the URL bar that the reader can share with someone else. Try it with the headings on this page!

</div>

34 changes: 30 additions & 4 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ const PAGE_CONTENT_ID = 'page-content';
const SITE_NAV_ID = 'site-nav';
const TITLE_PREFIX_SEPARATOR = ' - ';

const ANCHOR_HTML = '<a class="fa fa-anchor" href="#"></a>';
const DROPDOWN_BUTTON_ICON_HTML = '<i class="dropdown-btn-icon">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
Expand DownExpand Up@@ -219,16 +220,25 @@ Page.prototype.collectHeadingsAndKeywords = function () {
 this.collectHeadingsAndKeywordsInContent($(`#${CONTENT_WRAPPER_ID}`).html(), null);
};

/**
 * Generates a heading selector based on the indexing level
 * @param headingIndexingLevel to generate
 */
function generateHeadingSelector(headingIndexingLevel) {
 let headingsSelector = 'h1';
 for (let i = 2; i <= headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 return headingsSelector;
}

/**
 * Records headings and keywords inside content into this.headings and this.keywords respectively
 * @param content that contains the headings and keywords
 */
Page.prototype.collectHeadingsAndKeywordsInContent = function (content, lastHeading) {
 let $ = cheerio.load(content);
 let headingsSelector = 'h1';
 for (let i = 2; i <= this.headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $('modal').remove();
 $('panel').not('panel panel')
 .each((index, panel) => {
Expand DownExpand Up@@ -309,6 +319,21 @@ Page.prototype.concatenateHeadingsAndKeywords = function () {
 });
};

/**
 * Adds anchor links to headings in the page
 * @param content of the page
 */
Page.prototype.addAnchors = function (content) {
 const $ = cheerio.load(content, { xmlMode: false });
 if (this.headingIndexingLevel > 0) {
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $(headingsSelector).each((i, heading) => {
 $(heading).append(ANCHOR_HTML.replace('#', `#${$(heading).attr('id')}`));
 });
 }
 return $.html();
};

/**
 * Records the dynamic or static included files into this.includedFiles
 * @param dependencies array of maps of the external dependency and where it is included
Expand DownExpand Up@@ -471,6 +496,7 @@ Page.prototype.generate = function (builtFiles) {
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
 .then(result => fs.outputFileAsync(this.tempPath, result))
 .then(() => markbinder.renderFile(this.tempPath, fileConfig))
 .then(result => this.addAnchors(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

6 changes: 3 additions & 3 deletions
test/test_site/expected/bugs/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 </navbar>
 </div>
 <div class="website-content">
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute</h2>
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute<a class="fa fa-anchor" href="#popover-initiated-by-trigger-honor-trigger-attribute"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/49">Issue #49</a></p>
 <p>Repro:</p>
 <p>
Expand All@@ -40,7 +40,7 @@ <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated
 </div>
 </div>
 </popover>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal</h2>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal<a class="fa fa-anchor" href="#support-multiple-inclusions-of-a-modal"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/107">Issue #107</a></p>
 <p>Repro:</p>
 <div>
Expand All@@ -65,7 +65,7 @@ <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a
 </div>
 </modal>
 </div>
 <h2 id="remove-extra-space-in-links">Remove extra space in links</h2>
 <h2 id="remove-extra-space-in-links">Remove extra space in links<a class="fa fa-anchor" href="#remove-extra-space-in-links"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/147">Issue #147</a></p>
 <p>Repro:</p>
 <p>This is a link. [
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('^' + ".*" + '
Show anchor links for each heading by jamos-tay · Pull Request #433 · MarkBind/markbind · GitHub
Skip to content
Show anchor links for each heading#433

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

yamgent
merged 1 commit into

from

Sep 28, 2018
 Merged


Show anchor links for each heading
#433
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


13 changes: 13 additions & 0 deletions
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,19 @@ pre > code.hljs {
 outline: none !important;
}

.fa.fa-anchor {
 color: #ccc;
 display: none;
 font-size: 14px;
 margin-left: 10px;
 padding: 3px;
 text-decoration: none;
}

.fa.fa-anchor:hover {
 color: #555;
}

.markbind-table {
 width: auto;
}
Expand Down

12 changes: 12 additions & 0 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,21 @@ function flattenModals() {
 });
}

function setupAnchorVisibility() {
 jQuery('h1, h2, h3, h4, h5, h6').each((index, heading) => {
 jQuery(heading).on('mouseenter', function () {
 jQuery(this).children('.fa.fa-anchor').show();
 });
 jQuery(heading).on('mouseleave', function () {
 jQuery(this).children('.fa.fa-anchor').hide();
 });
 });
}

function executeAfterMountedRoutines() {
 flattenModals();
 scrollToUrlAnchorHeading();
 setupAnchorVisibility();
Comment thread
jamos-tay marked this conversation as resolved.

}

function setupSiteNav() {
Expand Down

10 changes: 9 additions & 1 deletion
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -589,4 +589,12 @@ Note:
- Footers should not be nested in other components or HTML tags. If found inside, they will be shifted outside to be rendered properly.
- [MarkBind components](#use-components) and [includes](#include-contents) are not supported in footers.

</div>
### Heading Anchors

Your site's readers may want to obtain a link to a heading within a page, to share with someone else for example.

MarkBind automatically generates heading anchors for your page.

When the reader hovers over a heading in your page, a small anchor icon <i class="fas fa-anchor"></i> will become visible next to the heading. Clicking this icon will redirect the page to that heading, producing the desired URL in the URL bar that the reader can share with someone else. Try it with the headings on this page!

</div>

34 changes: 30 additions & 4 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ const PAGE_CONTENT_ID = 'page-content';
const SITE_NAV_ID = 'site-nav';
const TITLE_PREFIX_SEPARATOR = ' - ';

const ANCHOR_HTML = '<a class="fa fa-anchor" href="#"></a>';
const DROPDOWN_BUTTON_ICON_HTML = '<i class="dropdown-btn-icon">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
Expand DownExpand Up@@ -219,16 +220,25 @@ Page.prototype.collectHeadingsAndKeywords = function () {
 this.collectHeadingsAndKeywordsInContent($(`#${CONTENT_WRAPPER_ID}`).html(), null);
};

/**
 * Generates a heading selector based on the indexing level
 * @param headingIndexingLevel to generate
 */
function generateHeadingSelector(headingIndexingLevel) {
 let headingsSelector = 'h1';
 for (let i = 2; i <= headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 return headingsSelector;
}

/**
 * Records headings and keywords inside content into this.headings and this.keywords respectively
 * @param content that contains the headings and keywords
 */
Page.prototype.collectHeadingsAndKeywordsInContent = function (content, lastHeading) {
 let $ = cheerio.load(content);
 let headingsSelector = 'h1';
 for (let i = 2; i <= this.headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $('modal').remove();
 $('panel').not('panel panel')
 .each((index, panel) => {
Expand DownExpand Up@@ -309,6 +319,21 @@ Page.prototype.concatenateHeadingsAndKeywords = function () {
 });
};

/**
 * Adds anchor links to headings in the page
 * @param content of the page
 */
Page.prototype.addAnchors = function (content) {
 const $ = cheerio.load(content, { xmlMode: false });
 if (this.headingIndexingLevel > 0) {
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $(headingsSelector).each((i, heading) => {
 $(heading).append(ANCHOR_HTML.replace('#', `#${$(heading).attr('id')}`));
 });
 }
 return $.html();
};

/**
 * Records the dynamic or static included files into this.includedFiles
 * @param dependencies array of maps of the external dependency and where it is included
Expand DownExpand Up@@ -471,6 +496,7 @@ Page.prototype.generate = function (builtFiles) {
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
 .then(result => fs.outputFileAsync(this.tempPath, result))
 .then(() => markbinder.renderFile(this.tempPath, fileConfig))
 .then(result => this.addAnchors(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

6 changes: 3 additions & 3 deletions
test/test_site/expected/bugs/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 </navbar>
 </div>
 <div class="website-content">
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute</h2>
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute<a class="fa fa-anchor" href="#popover-initiated-by-trigger-honor-trigger-attribute"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/49">Issue #49</a></p>
 <p>Repro:</p>
 <p>
Expand All@@ -40,7 +40,7 @@ <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated
 </div>
 </div>
 </popover>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal</h2>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal<a class="fa fa-anchor" href="#support-multiple-inclusions-of-a-modal"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/107">Issue #107</a></p>
 <p>Repro:</p>
 <div>
Expand All@@ -65,7 +65,7 @@ <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a
 </div>
 </modal>
 </div>
 <h2 id="remove-extra-space-in-links">Remove extra space in links</h2>
 <h2 id="remove-extra-space-in-links">Remove extra space in links<a class="fa fa-anchor" href="#remove-extra-space-in-links"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/147">Issue #147</a></p>
 <p>Repro:</p>
 <p>This is a link. [
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('^' + ".*" + '
Show anchor links for each heading by jamos-tay · Pull Request #433 · MarkBind/markbind · GitHub
Skip to content
Show anchor links for each heading#433

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

yamgent
merged 1 commit into

from

Sep 28, 2018
 Merged


Show anchor links for each heading
#433
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


13 changes: 13 additions & 0 deletions
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,19 @@ pre > code.hljs {
 outline: none !important;
}

.fa.fa-anchor {
 color: #ccc;
 display: none;
 font-size: 14px;
 margin-left: 10px;
 padding: 3px;
 text-decoration: none;
}

.fa.fa-anchor:hover {
 color: #555;
}

.markbind-table {
 width: auto;
}
Expand Down

12 changes: 12 additions & 0 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,21 @@ function flattenModals() {
 });
}

function setupAnchorVisibility() {
 jQuery('h1, h2, h3, h4, h5, h6').each((index, heading) => {
 jQuery(heading).on('mouseenter', function () {
 jQuery(this).children('.fa.fa-anchor').show();
 });
 jQuery(heading).on('mouseleave', function () {
 jQuery(this).children('.fa.fa-anchor').hide();
 });
 });
}

function executeAfterMountedRoutines() {
 flattenModals();
 scrollToUrlAnchorHeading();
 setupAnchorVisibility();
Comment thread
jamos-tay marked this conversation as resolved.

}

function setupSiteNav() {
Expand Down

10 changes: 9 additions & 1 deletion
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -589,4 +589,12 @@ Note:
- Footers should not be nested in other components or HTML tags. If found inside, they will be shifted outside to be rendered properly.
- [MarkBind components](#use-components) and [includes](#include-contents) are not supported in footers.

</div>
### Heading Anchors

Your site's readers may want to obtain a link to a heading within a page, to share with someone else for example.

MarkBind automatically generates heading anchors for your page.

When the reader hovers over a heading in your page, a small anchor icon <i class="fas fa-anchor"></i> will become visible next to the heading. Clicking this icon will redirect the page to that heading, producing the desired URL in the URL bar that the reader can share with someone else. Try it with the headings on this page!

</div>

34 changes: 30 additions & 4 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ const PAGE_CONTENT_ID = 'page-content';
const SITE_NAV_ID = 'site-nav';
const TITLE_PREFIX_SEPARATOR = ' - ';

const ANCHOR_HTML = '<a class="fa fa-anchor" href="#"></a>';
const DROPDOWN_BUTTON_ICON_HTML = '<i class="dropdown-btn-icon">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
Expand DownExpand Up@@ -219,16 +220,25 @@ Page.prototype.collectHeadingsAndKeywords = function () {
 this.collectHeadingsAndKeywordsInContent($(`#${CONTENT_WRAPPER_ID}`).html(), null);
};

/**
 * Generates a heading selector based on the indexing level
 * @param headingIndexingLevel to generate
 */
function generateHeadingSelector(headingIndexingLevel) {
 let headingsSelector = 'h1';
 for (let i = 2; i <= headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 return headingsSelector;
}

/**
 * Records headings and keywords inside content into this.headings and this.keywords respectively
 * @param content that contains the headings and keywords
 */
Page.prototype.collectHeadingsAndKeywordsInContent = function (content, lastHeading) {
 let $ = cheerio.load(content);
 let headingsSelector = 'h1';
 for (let i = 2; i <= this.headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $('modal').remove();
 $('panel').not('panel panel')
 .each((index, panel) => {
Expand DownExpand Up@@ -309,6 +319,21 @@ Page.prototype.concatenateHeadingsAndKeywords = function () {
 });
};

/**
 * Adds anchor links to headings in the page
 * @param content of the page
 */
Page.prototype.addAnchors = function (content) {
 const $ = cheerio.load(content, { xmlMode: false });
 if (this.headingIndexingLevel > 0) {
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $(headingsSelector).each((i, heading) => {
 $(heading).append(ANCHOR_HTML.replace('#', `#${$(heading).attr('id')}`));
 });
 }
 return $.html();
};

/**
 * Records the dynamic or static included files into this.includedFiles
 * @param dependencies array of maps of the external dependency and where it is included
Expand DownExpand Up@@ -471,6 +496,7 @@ Page.prototype.generate = function (builtFiles) {
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
 .then(result => fs.outputFileAsync(this.tempPath, result))
 .then(() => markbinder.renderFile(this.tempPath, fileConfig))
 .then(result => this.addAnchors(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

6 changes: 3 additions & 3 deletions
test/test_site/expected/bugs/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 </navbar>
 </div>
 <div class="website-content">
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute</h2>
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute<a class="fa fa-anchor" href="#popover-initiated-by-trigger-honor-trigger-attribute"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/49">Issue #49</a></p>
 <p>Repro:</p>
 <p>
Expand All@@ -40,7 +40,7 @@ <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated
 </div>
 </div>
 </popover>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal</h2>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal<a class="fa fa-anchor" href="#support-multiple-inclusions-of-a-modal"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/107">Issue #107</a></p>
 <p>Repro:</p>
 <div>
Expand All@@ -65,7 +65,7 @@ <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a
 </div>
 </modal>
 </div>
 <h2 id="remove-extra-space-in-links">Remove extra space in links</h2>
 <h2 id="remove-extra-space-in-links">Remove extra space in links<a class="fa fa-anchor" href="#remove-extra-space-in-links"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/147">Issue #147</a></p>
 <p>Repro:</p>
 <p>This is a link. [
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); }
})();
})();
Show anchor links for each heading by jamos-tay · Pull Request #433 · MarkBind/markbind · GitHub
Skip to content
Show anchor links for each heading#433

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

yamgent
merged 1 commit into

from

Sep 28, 2018
 Merged


Show anchor links for each heading
#433
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


13 changes: 13 additions & 0 deletions
asset/css/markbind.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,19 @@ pre > code.hljs {
 outline: none !important;
}

.fa.fa-anchor {
 color: #ccc;
 display: none;
 font-size: 14px;
 margin-left: 10px;
 padding: 3px;
 text-decoration: none;
}

.fa.fa-anchor:hover {
 color: #555;
}

.markbind-table {
 width: auto;
}
Expand Down

12 changes: 12 additions & 0 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,21 @@ function flattenModals() {
 });
}

function setupAnchorVisibility() {
 jQuery('h1, h2, h3, h4, h5, h6').each((index, heading) => {
 jQuery(heading).on('mouseenter', function () {
 jQuery(this).children('.fa.fa-anchor').show();
 });
 jQuery(heading).on('mouseleave', function () {
 jQuery(this).children('.fa.fa-anchor').hide();
 });
 });
}

function executeAfterMountedRoutines() {
 flattenModals();
 scrollToUrlAnchorHeading();
 setupAnchorVisibility();
Comment thread
jamos-tay marked this conversation as resolved.

}

function setupSiteNav() {
Expand Down

10 changes: 9 additions & 1 deletion
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -589,4 +589,12 @@ Note:
- Footers should not be nested in other components or HTML tags. If found inside, they will be shifted outside to be rendered properly.
- [MarkBind components](#use-components) and [includes](#include-contents) are not supported in footers.

</div>
### Heading Anchors

Your site's readers may want to obtain a link to a heading within a page, to share with someone else for example.

MarkBind automatically generates heading anchors for your page.

When the reader hovers over a heading in your page, a small anchor icon <i class="fas fa-anchor"></i> will become visible next to the heading. Clicking this icon will redirect the page to that heading, producing the desired URL in the URL bar that the reader can share with someone else. Try it with the headings on this page!

</div>

34 changes: 30 additions & 4 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ const PAGE_CONTENT_ID = 'page-content';
const SITE_NAV_ID = 'site-nav';
const TITLE_PREFIX_SEPARATOR = ' - ';

const ANCHOR_HTML = '<a class="fa fa-anchor" href="#"></a>';
const DROPDOWN_BUTTON_ICON_HTML = '<i class="dropdown-btn-icon">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
Expand DownExpand Up@@ -219,16 +220,25 @@ Page.prototype.collectHeadingsAndKeywords = function () {
 this.collectHeadingsAndKeywordsInContent($(`#${CONTENT_WRAPPER_ID}`).html(), null);
};

/**
 * Generates a heading selector based on the indexing level
 * @param headingIndexingLevel to generate
 */
function generateHeadingSelector(headingIndexingLevel) {
 let headingsSelector = 'h1';
 for (let i = 2; i <= headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 return headingsSelector;
}

/**
 * Records headings and keywords inside content into this.headings and this.keywords respectively
 * @param content that contains the headings and keywords
 */
Page.prototype.collectHeadingsAndKeywordsInContent = function (content, lastHeading) {
 let $ = cheerio.load(content);
 let headingsSelector = 'h1';
 for (let i = 2; i <= this.headingIndexingLevel; i += 1) {
 headingsSelector += `, h${i}`;
 }
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $('modal').remove();
 $('panel').not('panel panel')
 .each((index, panel) => {
Expand DownExpand Up@@ -309,6 +319,21 @@ Page.prototype.concatenateHeadingsAndKeywords = function () {
 });
};

/**
 * Adds anchor links to headings in the page
 * @param content of the page
 */
Page.prototype.addAnchors = function (content) {
 const $ = cheerio.load(content, { xmlMode: false });
 if (this.headingIndexingLevel > 0) {
 const headingsSelector = generateHeadingSelector(this.headingIndexingLevel);
 $(headingsSelector).each((i, heading) => {
 $(heading).append(ANCHOR_HTML.replace('#', `#${$(heading).attr('id')}`));
 });
 }
 return $.html();
};

/**
 * Records the dynamic or static included files into this.includedFiles
 * @param dependencies array of maps of the external dependency and where it is included
Expand DownExpand Up@@ -471,6 +496,7 @@ Page.prototype.generate = function (builtFiles) {
 .then(result => markbinder.resolveBaseUrl(result, fileConfig))
 .then(result => fs.outputFileAsync(this.tempPath, result))
 .then(() => markbinder.renderFile(this.tempPath, fileConfig))
 .then(result => this.addAnchors(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

6 changes: 3 additions & 3 deletions
test/test_site/expected/bugs/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 </navbar>
 </div>
 <div class="website-content">
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute</h2>
 <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated by trigger: honor trigger attribute<a class="fa fa-anchor" href="#popover-initiated-by-trigger-honor-trigger-attribute"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/49">Issue #49</a></p>
 <p>Repro:</p>
 <p>
Expand All@@ -40,7 +40,7 @@ <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated
 </div>
 </div>
 </popover>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal</h2>
 <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a modal<a class="fa fa-anchor" href="#support-multiple-inclusions-of-a-modal"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/107">Issue #107</a></p>
 <p>Repro:</p>
 <div>
Expand All@@ -65,7 +65,7 @@ <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a
 </div>
 </modal>
 </div>
 <h2 id="remove-extra-space-in-links">Remove extra space in links</h2>
 <h2 id="remove-extra-space-in-links">Remove extra space in links<a class="fa fa-anchor" href="#remove-extra-space-in-links"></a></h2>
 <p><a href="https://github.com/MarkBind/markbind/issues/147">Issue #147</a></p>
 <p>Repro:</p>
 <p>This is a link. [
Expand Down
Loading