Skip to content

Show anchor links for each heading - #433

Merged
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors
Sep 28, 2018
Merged

Show anchor links for each heading#433
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors

Conversation

@jamos-tay

@jamos-tayjamos-tay commented Sep 18, 2018

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#426

What is the rationale for this request?

Users may want to share a link to a specific heading with others.

What changes did you make? (Give an overview)

Allow users to automatically generate anchor links for each heading that direct the URL to that heading.

Provide some example code that this change will affect:

Users must include an anchors property in the frontmatter:

anchors: true

Functions similar to https://developers.timekit.io/v2/reference#section-root-endpoint-versions-and-protocol

  • Hovering over a header shows an anchor icon
  • Clicking on the icon links the URL to the header

out2

Is there anything you'd like reviewers to focus on?

Should we make the behavior different from the example site (e.g. change the icon)?

@jamos-tayjamos-tay changed the title [WIP] Show anchor links for each headingShow anchor links for each headingSep 18, 2018
@yamgent

Copy link
Copy Markdown
Member

Users must include an anchors property in the frontmatter:

anchors: true

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Was wondering whether we should add a default option in site.json, and explore a way to specify it for multiple pages at once...

@yamgent

Copy link
Copy Markdown
Member

Should we make the behavior different from the example site (e.g. change the icon)?

Design in the example gif looks fine actually. 👍

@damithc

Copy link
Copy Markdown
Contributor

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Maybe no need for this to be configurable? i.e., we do it by default for all headings

@yamgent

Copy link
Copy Markdown
Member

i.e., we do it by default for all headings

That sounds good too.

@jamos-tay

jamos-tay commented Sep 22, 2018

Copy link
Copy Markdown
ContributorAuthor

Updated to solve merge conflict and automatically add anchors

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Tested the feature, works fine 👍.

Comment threadasset/js/setup.js
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
@jamos-tay

Copy link
Copy Markdown
ContributorAuthor

Updated

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One minor nit

Comment threaddocs/userGuide/contentAuthoring.md Outdated
@yamgentyamgent added this to the v1.12.1 milestone Sep 28, 2018
@yamgent
yamgent merged commit e23d8c8 into MarkBind:masterSep 28, 2018
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Show anchor links for each heading

4 participants

@jamos-tay@yamgent@damithc@acjh
, '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

Merged
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors
Sep 28, 2018
Merged

Show anchor links for each heading#433
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors

Conversation

@jamos-tay

@jamos-tayjamos-tay commented Sep 18, 2018

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#426

What is the rationale for this request?

Users may want to share a link to a specific heading with others.

What changes did you make? (Give an overview)

Allow users to automatically generate anchor links for each heading that direct the URL to that heading.

Provide some example code that this change will affect:

Users must include an anchors property in the frontmatter:

anchors: true

Functions similar to https://developers.timekit.io/v2/reference#section-root-endpoint-versions-and-protocol

  • Hovering over a header shows an anchor icon
  • Clicking on the icon links the URL to the header

out2

Is there anything you'd like reviewers to focus on?

Should we make the behavior different from the example site (e.g. change the icon)?

@jamos-tayjamos-tay changed the title [WIP] Show anchor links for each headingShow anchor links for each headingSep 18, 2018
@yamgent

Copy link
Copy Markdown
Member

Users must include an anchors property in the frontmatter:

anchors: true

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Was wondering whether we should add a default option in site.json, and explore a way to specify it for multiple pages at once...

@yamgent

Copy link
Copy Markdown
Member

Should we make the behavior different from the example site (e.g. change the icon)?

Design in the example gif looks fine actually. 👍

@damithc

Copy link
Copy Markdown
Contributor

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Maybe no need for this to be configurable? i.e., we do it by default for all headings

@yamgent

Copy link
Copy Markdown
Member

i.e., we do it by default for all headings

That sounds good too.

@jamos-tay

jamos-tay commented Sep 22, 2018

Copy link
Copy Markdown
ContributorAuthor

Updated to solve merge conflict and automatically add anchors

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Tested the feature, works fine 👍.

Comment threadasset/js/setup.js
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
@jamos-tay

Copy link
Copy Markdown
ContributorAuthor

Updated

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One minor nit

Comment threaddocs/userGuide/contentAuthoring.md Outdated
@yamgentyamgent added this to the v1.12.1 milestone Sep 28, 2018
@yamgent
yamgent merged commit e23d8c8 into MarkBind:masterSep 28, 2018
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Show anchor links for each heading

4 participants

@jamos-tay@yamgent@damithc@acjh
, '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

Merged
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors
Sep 28, 2018
Merged

Show anchor links for each heading#433
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors

Conversation

@jamos-tay

@jamos-tayjamos-tay commented Sep 18, 2018

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#426

What is the rationale for this request?

Users may want to share a link to a specific heading with others.

What changes did you make? (Give an overview)

Allow users to automatically generate anchor links for each heading that direct the URL to that heading.

Provide some example code that this change will affect:

Users must include an anchors property in the frontmatter:

anchors: true

Functions similar to https://developers.timekit.io/v2/reference#section-root-endpoint-versions-and-protocol

  • Hovering over a header shows an anchor icon
  • Clicking on the icon links the URL to the header

out2

Is there anything you'd like reviewers to focus on?

Should we make the behavior different from the example site (e.g. change the icon)?

@jamos-tayjamos-tay changed the title [WIP] Show anchor links for each headingShow anchor links for each headingSep 18, 2018
@yamgent

Copy link
Copy Markdown
Member

Users must include an anchors property in the frontmatter:

anchors: true

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Was wondering whether we should add a default option in site.json, and explore a way to specify it for multiple pages at once...

@yamgent

Copy link
Copy Markdown
Member

Should we make the behavior different from the example site (e.g. change the icon)?

Design in the example gif looks fine actually. 👍

@damithc

Copy link
Copy Markdown
Contributor

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Maybe no need for this to be configurable? i.e., we do it by default for all headings

@yamgent

Copy link
Copy Markdown
Member

i.e., we do it by default for all headings

That sounds good too.

@jamos-tay

jamos-tay commented Sep 22, 2018

Copy link
Copy Markdown
ContributorAuthor

Updated to solve merge conflict and automatically add anchors

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Tested the feature, works fine 👍.

Comment threadasset/js/setup.js
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
@jamos-tay

Copy link
Copy Markdown
ContributorAuthor

Updated

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One minor nit

Comment threaddocs/userGuide/contentAuthoring.md Outdated
@yamgentyamgent added this to the v1.12.1 milestone Sep 28, 2018
@yamgent
yamgent merged commit e23d8c8 into MarkBind:masterSep 28, 2018
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Show anchor links for each heading

4 participants

@jamos-tay@yamgent@damithc@acjh
, '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

Merged
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors
Sep 28, 2018
Merged

Show anchor links for each heading#433
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors

Conversation

@jamos-tay

@jamos-tayjamos-tay commented Sep 18, 2018

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#426

What is the rationale for this request?

Users may want to share a link to a specific heading with others.

What changes did you make? (Give an overview)

Allow users to automatically generate anchor links for each heading that direct the URL to that heading.

Provide some example code that this change will affect:

Users must include an anchors property in the frontmatter:

anchors: true

Functions similar to https://developers.timekit.io/v2/reference#section-root-endpoint-versions-and-protocol

  • Hovering over a header shows an anchor icon
  • Clicking on the icon links the URL to the header

out2

Is there anything you'd like reviewers to focus on?

Should we make the behavior different from the example site (e.g. change the icon)?

@jamos-tayjamos-tay changed the title [WIP] Show anchor links for each headingShow anchor links for each headingSep 18, 2018
@yamgent

Copy link
Copy Markdown
Member

Users must include an anchors property in the frontmatter:

anchors: true

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Was wondering whether we should add a default option in site.json, and explore a way to specify it for multiple pages at once...

@yamgent

Copy link
Copy Markdown
Member

Should we make the behavior different from the example site (e.g. change the icon)?

Design in the example gif looks fine actually. 👍

@damithc

Copy link
Copy Markdown
Contributor

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Maybe no need for this to be configurable? i.e., we do it by default for all headings

@yamgent

Copy link
Copy Markdown
Member

i.e., we do it by default for all headings

That sounds good too.

@jamos-tay

jamos-tay commented Sep 22, 2018

Copy link
Copy Markdown
ContributorAuthor

Updated to solve merge conflict and automatically add anchors

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Tested the feature, works fine 👍.

Comment threadasset/js/setup.js
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
@jamos-tay

Copy link
Copy Markdown
ContributorAuthor

Updated

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One minor nit

Comment threaddocs/userGuide/contentAuthoring.md Outdated
@yamgentyamgent added this to the v1.12.1 milestone Sep 28, 2018
@yamgent
yamgent merged commit e23d8c8 into MarkBind:masterSep 28, 2018
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Show anchor links for each heading

4 participants

@jamos-tay@yamgent@damithc@acjh
, '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

Merged
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors
Sep 28, 2018
Merged

Show anchor links for each heading#433
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors

Conversation

@jamos-tay

@jamos-tayjamos-tay commented Sep 18, 2018

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#426

What is the rationale for this request?

Users may want to share a link to a specific heading with others.

What changes did you make? (Give an overview)

Allow users to automatically generate anchor links for each heading that direct the URL to that heading.

Provide some example code that this change will affect:

Users must include an anchors property in the frontmatter:

anchors: true

Functions similar to https://developers.timekit.io/v2/reference#section-root-endpoint-versions-and-protocol

  • Hovering over a header shows an anchor icon
  • Clicking on the icon links the URL to the header

out2

Is there anything you'd like reviewers to focus on?

Should we make the behavior different from the example site (e.g. change the icon)?

@jamos-tayjamos-tay changed the title [WIP] Show anchor links for each headingShow anchor links for each headingSep 18, 2018
@yamgent

Copy link
Copy Markdown
Member

Users must include an anchors property in the frontmatter:

anchors: true

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Was wondering whether we should add a default option in site.json, and explore a way to specify it for multiple pages at once...

@yamgent

Copy link
Copy Markdown
Member

Should we make the behavior different from the example site (e.g. change the icon)?

Design in the example gif looks fine actually. 👍

@damithc

Copy link
Copy Markdown
Contributor

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Maybe no need for this to be configurable? i.e., we do it by default for all headings

@yamgent

Copy link
Copy Markdown
Member

i.e., we do it by default for all headings

That sounds good too.

@jamos-tay

jamos-tay commented Sep 22, 2018

Copy link
Copy Markdown
ContributorAuthor

Updated to solve merge conflict and automatically add anchors

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Tested the feature, works fine 👍.

Comment threadasset/js/setup.js
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
@jamos-tay

Copy link
Copy Markdown
ContributorAuthor

Updated

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One minor nit

Comment threaddocs/userGuide/contentAuthoring.md Outdated
@yamgentyamgent added this to the v1.12.1 milestone Sep 28, 2018
@yamgent
yamgent merged commit e23d8c8 into MarkBind:masterSep 28, 2018
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Show anchor links for each heading

4 participants

@jamos-tay@yamgent@damithc@acjh
, '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

Merged
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors
Sep 28, 2018
Merged

Show anchor links for each heading#433
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors

Conversation

@jamos-tay

@jamos-tayjamos-tay commented Sep 18, 2018

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#426

What is the rationale for this request?

Users may want to share a link to a specific heading with others.

What changes did you make? (Give an overview)

Allow users to automatically generate anchor links for each heading that direct the URL to that heading.

Provide some example code that this change will affect:

Users must include an anchors property in the frontmatter:

anchors: true

Functions similar to https://developers.timekit.io/v2/reference#section-root-endpoint-versions-and-protocol

  • Hovering over a header shows an anchor icon
  • Clicking on the icon links the URL to the header

out2

Is there anything you'd like reviewers to focus on?

Should we make the behavior different from the example site (e.g. change the icon)?

@jamos-tayjamos-tay changed the title [WIP] Show anchor links for each headingShow anchor links for each headingSep 18, 2018
@yamgent

Copy link
Copy Markdown
Member

Users must include an anchors property in the frontmatter:

anchors: true

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Was wondering whether we should add a default option in site.json, and explore a way to specify it for multiple pages at once...

@yamgent

Copy link
Copy Markdown
Member

Should we make the behavior different from the example site (e.g. change the icon)?

Design in the example gif looks fine actually. 👍

@damithc

Copy link
Copy Markdown
Contributor

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Maybe no need for this to be configurable? i.e., we do it by default for all headings

@yamgent

Copy link
Copy Markdown
Member

i.e., we do it by default for all headings

That sounds good too.

@jamos-tay

jamos-tay commented Sep 22, 2018

Copy link
Copy Markdown
ContributorAuthor

Updated to solve merge conflict and automatically add anchors

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Tested the feature, works fine 👍.

Comment threadasset/js/setup.js
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
@jamos-tay

Copy link
Copy Markdown
ContributorAuthor

Updated

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One minor nit

Comment threaddocs/userGuide/contentAuthoring.md Outdated
@yamgentyamgent added this to the v1.12.1 milestone Sep 28, 2018
@yamgent
yamgent merged commit e23d8c8 into MarkBind:masterSep 28, 2018
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Show anchor links for each heading

4 participants

@jamos-tay@yamgent@damithc@acjh
, '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); } })(); })(); 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

Merged
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors
Sep 28, 2018
Merged

Show anchor links for each heading#433
yamgent merged 1 commit into
MarkBind:masterfrom
jamos-tay:add-anchors

Conversation

@jamos-tay

@jamos-tayjamos-tay commented Sep 18, 2018

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#426

What is the rationale for this request?

Users may want to share a link to a specific heading with others.

What changes did you make? (Give an overview)

Allow users to automatically generate anchor links for each heading that direct the URL to that heading.

Provide some example code that this change will affect:

Users must include an anchors property in the frontmatter:

anchors: true

Functions similar to https://developers.timekit.io/v2/reference#section-root-endpoint-versions-and-protocol

  • Hovering over a header shows an anchor icon
  • Clicking on the icon links the URL to the header

out2

Is there anything you'd like reviewers to focus on?

Should we make the behavior different from the example site (e.g. change the icon)?

@jamos-tayjamos-tay changed the title [WIP] Show anchor links for each headingShow anchor links for each headingSep 18, 2018
@yamgent

Copy link
Copy Markdown
Member

Users must include an anchors property in the frontmatter:

anchors: true

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Was wondering whether we should add a default option in site.json, and explore a way to specify it for multiple pages at once...

@yamgent

Copy link
Copy Markdown
Member

Should we make the behavior different from the example site (e.g. change the icon)?

Design in the example gif looks fine actually. 👍

@damithc

Copy link
Copy Markdown
Contributor

This seems kind of troublesome if there's a lot of such pages (if not all) in the website though (slightly similar to #389).

Maybe no need for this to be configurable? i.e., we do it by default for all headings

@yamgent

Copy link
Copy Markdown
Member

i.e., we do it by default for all headings

That sounds good too.

@jamos-tay

jamos-tay commented Sep 22, 2018

Copy link
Copy Markdown
ContributorAuthor

Updated to solve merge conflict and automatically add anchors

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Tested the feature, works fine 👍.

Comment threadasset/js/setup.js
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
@jamos-tay

Copy link
Copy Markdown
ContributorAuthor

Updated

@yamgentyamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One minor nit

Comment threaddocs/userGuide/contentAuthoring.md Outdated
@yamgentyamgent added this to the v1.12.1 milestone Sep 28, 2018
@yamgent
yamgent merged commit e23d8c8 into MarkBind:masterSep 28, 2018
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Show anchor links for each heading

4 participants

@jamos-tay@yamgent@damithc@acjh