Support searching for headings#240

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 4 commits into from
Jun 4, 2018
Merged

Support searching for headings #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
12de50b
Page: Collect headings for siteData.json
nusjzx Jun 4, 2018
5c6b200
Search: Replace typeahead with searchbar
nusjzx Jun 4, 2018
fe5505e
Test: add headings in siteData.json
nusjzx Jun 4, 2018
12b0ed1
Docs: Replace typeahead with searchbar
nusjzx Jun 4, 2018
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
16 changes: 6 additions & 10 deletions asset/js/setup.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,26 +10,22 @@ function setup() {
}

function setupWithSearch(siteData) {
const { typeahead } = VueStrap.components;
const { searchbar } = VueStrap.components;
const vm = new Vue({
el: '#app',
components: {
typeahead,
searchbar,
},
data() {
const helpers = {
value() { return [this.title].concat(this.keywords).join(' '); },
indexOf(query) { return this.value().indexOf(query); },
toLowerCase() { return this.value().toLowerCase(); },
};
return {
searchData: siteData.pages.map(page => Object.assign({}, page, helpers)),
titleTemplate: '{{ item.title }}<br><sub>{{ item.keywords }}</sub>',
searchData: siteData.pages,
};
},
methods: {
searchCallback(match) {
window.location = `${baseUrl}/${match.src.replace('.md', '.html')}`;
const page = `${baseUrl}/${match.src.replace('.md', '.html')}`;
const anchor = match.heading ? `#${match.heading.id}` : '';
window.location = `${page}${anchor}`;
},
},
});
Expand Down
5 changes: 5 additions & 0 deletions docs/common/header.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,9 @@
<svg height="16px" fill="#777" class="octicon octicon-mark-github" viewBox="0 0 16 16" version="1.1" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path></svg>
</a>
</li>
<li slot="right">
<form class="navbar-form">
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
</form>
</li>
</navbar>
4 changes: 2 additions & 2 deletions docs/userGuide/contentAuthoring.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -166,15 +166,15 @@ In any file in your site, you can include the variable by surrounding the variab
To use the searchbar, add the following markup to your file.

```html
<typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead>
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
```

To use the searchbar within a navbar, add the following markup to your file. The searchbar can be positioned using the slot attribute for the list. The following markup adds a searchbar to the right side of the navbar with appropriate styling.

```html
<li slot="right">
<form class="navbar-form">
<typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead>
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
</form>
</li>
```
Expand Down
14 changes: 14 additions & 0 deletions lib/Page.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ function Page(pageConfig) {
this.resultPath = pageConfig.resultPath;

this.frontMatter = {};
this.headings = {};
this.includedFiles = {};
}

Expand DownExpand Up@@ -80,6 +81,18 @@ Page.prototype.prepareTemplateData = function () {
};
};

/**
* Records h1,h2,h3 headings into this.headings
* @param renderedPage a page with its headings rendered
*/
Page.prototype.collectHeadings = function (renderedPage) {
const $ = cheerio.load(renderedPage);
$('h1,h2,h3').each((i, heading) => {
this.headings[$(heading).attr('id')] = $(heading).text();
});
return renderedPage;
};

/**
* 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@@ -153,6 +166,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.collectHeadings(result))
.then((result) => {
this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down
5 changes: 4 additions & 1 deletion lib/Site.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -507,7 +507,10 @@ Site.prototype.copyMarkBindAsset = function () {
Site.prototype.writeSiteData = function () {
return new Promise((resolve, reject) => {
const siteDataPath = path.join(this.outputPath, SITE_DATA_NAME);
const siteData = { pages: this.pages.map(page => (page.frontMatter)) };
const siteData = {
pages: this.pages.map(page => Object.assign({ headings: page.headings }, page.frontMatter)),
};

fs.outputJsonAsync(siteDataPath, siteData)
.then(() => logger.info('Site data built'))
.then(resolve)
Expand Down
19 changes: 19 additions & 0 deletions test/test_site/expected/siteData.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
{
"pages": [
{
"headings": {
"normal-include": "Normal include",
"establishing-requirements": "Establishing Requirements",
"include-segment": "Include segment",
"dynamic-include": "Dynamic include",
"boilerplate-include": "Boilerplate include",
"nested-include": "Nested include",
"html-include": "HTML include",
"include-from-another-markbind-site": "Include from another Markbind site",
"feature-list": "Feature list"
},

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

"title": "Hello World",
"src": "index.md"
},
{
"headings": {
"popover-initiated-by-trigger-honor-trigger-attribute": "popover initiated by trigger: honor trigger attribute",
"support-multiple-inclusions-of-a-modal": "Support multiple inclusions of a modal",
"remove-extra-space-in-links": "Remove extra space in links"
},
"title": "Open Bugs",
"src": "bugs/index.md"
},
{
"headings": {
"feature-list": "Feature list"
},
"src": "sub_site/index.md",
"title": ""
}
Expand Down
, '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" + '

Skip to content
Support searching for headings#240

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 4 commits into

from

Jun 4, 2018
 Merged


Support searching for headings
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
12de50b

Page: Collect headings for siteData.json


nusjzx Jun 4, 2018
5c6b200

Search: Replace typeahead with searchbar


nusjzx Jun 4, 2018
fe5505e

Test: add headings in siteData.json


nusjzx Jun 4, 2018
12b0ed1

Docs: Replace typeahead with searchbar


nusjzx Jun 4, 2018

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


16 changes: 6 additions & 10 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,26 +10,22 @@ function setup() {
}

function setupWithSearch(siteData) {
 const { typeahead } = VueStrap.components;
 const { searchbar } = VueStrap.components;
 const vm = new Vue({
 el: '#app',
 components: {
typeahead,
searchbar,
 },
 data() {
 const helpers = {
 value() { return [this.title].concat(this.keywords).join(' '); },
 indexOf(query) { return this.value().indexOf(query); },
 toLowerCase() { return this.value().toLowerCase(); },
 };
 return {
 searchData: siteData.pages.map(page => Object.assign({}, page, helpers)),
 titleTemplate: '{{ item.title }}<br><sub>{{ item.keywords }}</sub>',
 searchData: siteData.pages,
 };
 },
 methods: {
 searchCallback(match) {
 window.location = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const page = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const anchor = match.heading ? `#${match.heading.id}` : '';
 window.location = `${page}${anchor}`;
 },
 },
 });
Expand Down

5 changes: 5 additions & 0 deletions
docs/common/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,9 @@
 <svg height="16px" fill="#777" class="octicon octicon-mark-github" viewBox="0 0 16 16" version="1.1" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path></svg>
 </a>
 </li>
 <li slot="right">
 <form class="navbar-form">
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
 </li>
</navbar>

4 changes: 2 additions & 2 deletions
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,15 +166,15 @@ In any file in your site, you can include the variable by surrounding the variab
To use the searchbar, add the following markup to your file.

```html
<typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead>
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
```

To use the searchbar within a navbar, add the following markup to your file. The searchbar can be positioned using the slot attribute for the list. The following markup adds a searchbar to the right side of the navbar with appropriate styling.

```html
<li slot="right">
 <form class="navbar-form">
 <typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead> 
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
</li>
```
Expand Down

14 changes: 14 additions & 0 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ function Page(pageConfig) {
 this.resultPath = pageConfig.resultPath;

 this.frontMatter = {};
 this.headings = {};
 this.includedFiles = {};
}

Expand DownExpand Up@@ -80,6 +81,18 @@ Page.prototype.prepareTemplateData = function () {
 };
};

/**
 * Records h1,h2,h3 headings into this.headings
 * @param renderedPage a page with its headings rendered
 */
Page.prototype.collectHeadings = function (renderedPage) {
 const $ = cheerio.load(renderedPage);
 $('h1,h2,h3').each((i, heading) => {
 this.headings[$(heading).attr('id')] = $(heading).text();
 });
 return renderedPage;
};

/**
 * 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@@ -153,6 +166,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.collectHeadings(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

5 changes: 4 additions & 1 deletion
lib/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,7 +507,10 @@ Site.prototype.copyMarkBindAsset = function () {
Site.prototype.writeSiteData = function () {
 return new Promise((resolve, reject) => {
 const siteDataPath = path.join(this.outputPath, SITE_DATA_NAME);
 const siteData = { pages: this.pages.map(page => (page.frontMatter)) };
 const siteData = {
 pages: this.pages.map(page => Object.assign({ headings: page.headings }, page.frontMatter)),
 };

 fs.outputJsonAsync(siteDataPath, siteData)
 .then(() => logger.info('Site data built'))
 .then(resolve)
Expand Down

19 changes: 19 additions & 0 deletions
test/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
{
 "pages": [
 {
 "headings": {
 "normal-include": "Normal include",
 "establishing-requirements": "Establishing Requirements",
 "include-segment": "Include segment",
 "dynamic-include": "Dynamic include",
 "boilerplate-include": "Boilerplate include",
 "nested-include": "Nested include",
 "html-include": "HTML include",
 "include-from-another-markbind-site": "Include from another Markbind site",
 "feature-list": "Feature list"
 },

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view
 "title": "Hello World",
 "src": "index.md"
 },
 {
 "headings": {
 "popover-initiated-by-trigger-honor-trigger-attribute": "popover initiated by trigger: honor trigger attribute",
 "support-multiple-inclusions-of-a-modal": "Support multiple inclusions of a modal",
 "remove-extra-space-in-links": "Remove extra space in links"
 },
 "title": "Open Bugs",
 "src": "bugs/index.md"
 },
 {
 "headings": {
 "feature-list": "Feature list"
 },
 "src": "sub_site/index.md",
 "title": ""
 }
Expand Down

, '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('^' + ".*" + '

Skip to content
Support searching for headings#240

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 4 commits into

from

Jun 4, 2018
 Merged


Support searching for headings
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
12de50b

Page: Collect headings for siteData.json


nusjzx Jun 4, 2018
5c6b200

Search: Replace typeahead with searchbar


nusjzx Jun 4, 2018
fe5505e

Test: add headings in siteData.json


nusjzx Jun 4, 2018
12b0ed1

Docs: Replace typeahead with searchbar


nusjzx Jun 4, 2018

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


16 changes: 6 additions & 10 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,26 +10,22 @@ function setup() {
}

function setupWithSearch(siteData) {
 const { typeahead } = VueStrap.components;
 const { searchbar } = VueStrap.components;
 const vm = new Vue({
 el: '#app',
 components: {
typeahead,
searchbar,
 },
 data() {
 const helpers = {
 value() { return [this.title].concat(this.keywords).join(' '); },
 indexOf(query) { return this.value().indexOf(query); },
 toLowerCase() { return this.value().toLowerCase(); },
 };
 return {
 searchData: siteData.pages.map(page => Object.assign({}, page, helpers)),
 titleTemplate: '{{ item.title }}<br><sub>{{ item.keywords }}</sub>',
 searchData: siteData.pages,
 };
 },
 methods: {
 searchCallback(match) {
 window.location = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const page = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const anchor = match.heading ? `#${match.heading.id}` : '';
 window.location = `${page}${anchor}`;
 },
 },
 });
Expand Down

5 changes: 5 additions & 0 deletions
docs/common/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,9 @@
 <svg height="16px" fill="#777" class="octicon octicon-mark-github" viewBox="0 0 16 16" version="1.1" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path></svg>
 </a>
 </li>
 <li slot="right">
 <form class="navbar-form">
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
 </li>
</navbar>

4 changes: 2 additions & 2 deletions
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,15 +166,15 @@ In any file in your site, you can include the variable by surrounding the variab
To use the searchbar, add the following markup to your file.

```html
<typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead>
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
```

To use the searchbar within a navbar, add the following markup to your file. The searchbar can be positioned using the slot attribute for the list. The following markup adds a searchbar to the right side of the navbar with appropriate styling.

```html
<li slot="right">
 <form class="navbar-form">
 <typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead> 
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
</li>
```
Expand Down

14 changes: 14 additions & 0 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ function Page(pageConfig) {
 this.resultPath = pageConfig.resultPath;

 this.frontMatter = {};
 this.headings = {};
 this.includedFiles = {};
}

Expand DownExpand Up@@ -80,6 +81,18 @@ Page.prototype.prepareTemplateData = function () {
 };
};

/**
 * Records h1,h2,h3 headings into this.headings
 * @param renderedPage a page with its headings rendered
 */
Page.prototype.collectHeadings = function (renderedPage) {
 const $ = cheerio.load(renderedPage);
 $('h1,h2,h3').each((i, heading) => {
 this.headings[$(heading).attr('id')] = $(heading).text();
 });
 return renderedPage;
};

/**
 * 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@@ -153,6 +166,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.collectHeadings(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

5 changes: 4 additions & 1 deletion
lib/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,7 +507,10 @@ Site.prototype.copyMarkBindAsset = function () {
Site.prototype.writeSiteData = function () {
 return new Promise((resolve, reject) => {
 const siteDataPath = path.join(this.outputPath, SITE_DATA_NAME);
 const siteData = { pages: this.pages.map(page => (page.frontMatter)) };
 const siteData = {
 pages: this.pages.map(page => Object.assign({ headings: page.headings }, page.frontMatter)),
 };

 fs.outputJsonAsync(siteDataPath, siteData)
 .then(() => logger.info('Site data built'))
 .then(resolve)
Expand Down

19 changes: 19 additions & 0 deletions
test/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
{
 "pages": [
 {
 "headings": {
 "normal-include": "Normal include",
 "establishing-requirements": "Establishing Requirements",
 "include-segment": "Include segment",
 "dynamic-include": "Dynamic include",
 "boilerplate-include": "Boilerplate include",
 "nested-include": "Nested include",
 "html-include": "HTML include",
 "include-from-another-markbind-site": "Include from another Markbind site",
 "feature-list": "Feature list"
 },

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view
 "title": "Hello World",
 "src": "index.md"
 },
 {
 "headings": {
 "popover-initiated-by-trigger-honor-trigger-attribute": "popover initiated by trigger: honor trigger attribute",
 "support-multiple-inclusions-of-a-modal": "Support multiple inclusions of a modal",
 "remove-extra-space-in-links": "Remove extra space in links"
 },
 "title": "Open Bugs",
 "src": "bugs/index.md"
 },
 {
 "headings": {
 "feature-list": "Feature list"
 },
 "src": "sub_site/index.md",
 "title": ""
 }
Expand Down

, '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('^' + ".*" + '

Skip to content
Support searching for headings#240

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 4 commits into

from

Jun 4, 2018
 Merged


Support searching for headings
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
12de50b

Page: Collect headings for siteData.json


nusjzx Jun 4, 2018
5c6b200

Search: Replace typeahead with searchbar


nusjzx Jun 4, 2018
fe5505e

Test: add headings in siteData.json


nusjzx Jun 4, 2018
12b0ed1

Docs: Replace typeahead with searchbar


nusjzx Jun 4, 2018

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


16 changes: 6 additions & 10 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,26 +10,22 @@ function setup() {
}

function setupWithSearch(siteData) {
 const { typeahead } = VueStrap.components;
 const { searchbar } = VueStrap.components;
 const vm = new Vue({
 el: '#app',
 components: {
typeahead,
searchbar,
 },
 data() {
 const helpers = {
 value() { return [this.title].concat(this.keywords).join(' '); },
 indexOf(query) { return this.value().indexOf(query); },
 toLowerCase() { return this.value().toLowerCase(); },
 };
 return {
 searchData: siteData.pages.map(page => Object.assign({}, page, helpers)),
 titleTemplate: '{{ item.title }}<br><sub>{{ item.keywords }}</sub>',
 searchData: siteData.pages,
 };
 },
 methods: {
 searchCallback(match) {
 window.location = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const page = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const anchor = match.heading ? `#${match.heading.id}` : '';
 window.location = `${page}${anchor}`;
 },
 },
 });
Expand Down

5 changes: 5 additions & 0 deletions
docs/common/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,9 @@
 <svg height="16px" fill="#777" class="octicon octicon-mark-github" viewBox="0 0 16 16" version="1.1" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path></svg>
 </a>
 </li>
 <li slot="right">
 <form class="navbar-form">
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
 </li>
</navbar>

4 changes: 2 additions & 2 deletions
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,15 +166,15 @@ In any file in your site, you can include the variable by surrounding the variab
To use the searchbar, add the following markup to your file.

```html
<typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead>
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
```

To use the searchbar within a navbar, add the following markup to your file. The searchbar can be positioned using the slot attribute for the list. The following markup adds a searchbar to the right side of the navbar with appropriate styling.

```html
<li slot="right">
 <form class="navbar-form">
 <typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead> 
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
</li>
```
Expand Down

14 changes: 14 additions & 0 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ function Page(pageConfig) {
 this.resultPath = pageConfig.resultPath;

 this.frontMatter = {};
 this.headings = {};
 this.includedFiles = {};
}

Expand DownExpand Up@@ -80,6 +81,18 @@ Page.prototype.prepareTemplateData = function () {
 };
};

/**
 * Records h1,h2,h3 headings into this.headings
 * @param renderedPage a page with its headings rendered
 */
Page.prototype.collectHeadings = function (renderedPage) {
 const $ = cheerio.load(renderedPage);
 $('h1,h2,h3').each((i, heading) => {
 this.headings[$(heading).attr('id')] = $(heading).text();
 });
 return renderedPage;
};

/**
 * 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@@ -153,6 +166,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.collectHeadings(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

5 changes: 4 additions & 1 deletion
lib/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,7 +507,10 @@ Site.prototype.copyMarkBindAsset = function () {
Site.prototype.writeSiteData = function () {
 return new Promise((resolve, reject) => {
 const siteDataPath = path.join(this.outputPath, SITE_DATA_NAME);
 const siteData = { pages: this.pages.map(page => (page.frontMatter)) };
 const siteData = {
 pages: this.pages.map(page => Object.assign({ headings: page.headings }, page.frontMatter)),
 };

 fs.outputJsonAsync(siteDataPath, siteData)
 .then(() => logger.info('Site data built'))
 .then(resolve)
Expand Down

19 changes: 19 additions & 0 deletions
test/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
{
 "pages": [
 {
 "headings": {
 "normal-include": "Normal include",
 "establishing-requirements": "Establishing Requirements",
 "include-segment": "Include segment",
 "dynamic-include": "Dynamic include",
 "boilerplate-include": "Boilerplate include",
 "nested-include": "Nested include",
 "html-include": "HTML include",
 "include-from-another-markbind-site": "Include from another Markbind site",
 "feature-list": "Feature list"
 },

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view
 "title": "Hello World",
 "src": "index.md"
 },
 {
 "headings": {
 "popover-initiated-by-trigger-honor-trigger-attribute": "popover initiated by trigger: honor trigger attribute",
 "support-multiple-inclusions-of-a-modal": "Support multiple inclusions of a modal",
 "remove-extra-space-in-links": "Remove extra space in links"
 },
 "title": "Open Bugs",
 "src": "bugs/index.md"
 },
 {
 "headings": {
 "feature-list": "Feature list"
 },
 "src": "sub_site/index.md",
 "title": ""
 }
Expand Down

, '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" + '

Skip to content
Support searching for headings#240

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 4 commits into

from

Jun 4, 2018
 Merged


Support searching for headings
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
12de50b

Page: Collect headings for siteData.json


nusjzx Jun 4, 2018
5c6b200

Search: Replace typeahead with searchbar


nusjzx Jun 4, 2018
fe5505e

Test: add headings in siteData.json


nusjzx Jun 4, 2018
12b0ed1

Docs: Replace typeahead with searchbar


nusjzx Jun 4, 2018

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


16 changes: 6 additions & 10 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,26 +10,22 @@ function setup() {
}

function setupWithSearch(siteData) {
 const { typeahead } = VueStrap.components;
 const { searchbar } = VueStrap.components;
 const vm = new Vue({
 el: '#app',
 components: {
typeahead,
searchbar,
 },
 data() {
 const helpers = {
 value() { return [this.title].concat(this.keywords).join(' '); },
 indexOf(query) { return this.value().indexOf(query); },
 toLowerCase() { return this.value().toLowerCase(); },
 };
 return {
 searchData: siteData.pages.map(page => Object.assign({}, page, helpers)),
 titleTemplate: '{{ item.title }}<br><sub>{{ item.keywords }}</sub>',
 searchData: siteData.pages,
 };
 },
 methods: {
 searchCallback(match) {
 window.location = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const page = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const anchor = match.heading ? `#${match.heading.id}` : '';
 window.location = `${page}${anchor}`;
 },
 },
 });
Expand Down

5 changes: 5 additions & 0 deletions
docs/common/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,9 @@
 <svg height="16px" fill="#777" class="octicon octicon-mark-github" viewBox="0 0 16 16" version="1.1" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path></svg>
 </a>
 </li>
 <li slot="right">
 <form class="navbar-form">
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
 </li>
</navbar>

4 changes: 2 additions & 2 deletions
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,15 +166,15 @@ In any file in your site, you can include the variable by surrounding the variab
To use the searchbar, add the following markup to your file.

```html
<typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead>
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
```

To use the searchbar within a navbar, add the following markup to your file. The searchbar can be positioned using the slot attribute for the list. The following markup adds a searchbar to the right side of the navbar with appropriate styling.

```html
<li slot="right">
 <form class="navbar-form">
 <typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead> 
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
</li>
```
Expand Down

14 changes: 14 additions & 0 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ function Page(pageConfig) {
 this.resultPath = pageConfig.resultPath;

 this.frontMatter = {};
 this.headings = {};
 this.includedFiles = {};
}

Expand DownExpand Up@@ -80,6 +81,18 @@ Page.prototype.prepareTemplateData = function () {
 };
};

/**
 * Records h1,h2,h3 headings into this.headings
 * @param renderedPage a page with its headings rendered
 */
Page.prototype.collectHeadings = function (renderedPage) {
 const $ = cheerio.load(renderedPage);
 $('h1,h2,h3').each((i, heading) => {
 this.headings[$(heading).attr('id')] = $(heading).text();
 });
 return renderedPage;
};

/**
 * 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@@ -153,6 +166,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.collectHeadings(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

5 changes: 4 additions & 1 deletion
lib/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,7 +507,10 @@ Site.prototype.copyMarkBindAsset = function () {
Site.prototype.writeSiteData = function () {
 return new Promise((resolve, reject) => {
 const siteDataPath = path.join(this.outputPath, SITE_DATA_NAME);
 const siteData = { pages: this.pages.map(page => (page.frontMatter)) };
 const siteData = {
 pages: this.pages.map(page => Object.assign({ headings: page.headings }, page.frontMatter)),
 };

 fs.outputJsonAsync(siteDataPath, siteData)
 .then(() => logger.info('Site data built'))
 .then(resolve)
Expand Down

19 changes: 19 additions & 0 deletions
test/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
{
 "pages": [
 {
 "headings": {
 "normal-include": "Normal include",
 "establishing-requirements": "Establishing Requirements",
 "include-segment": "Include segment",
 "dynamic-include": "Dynamic include",
 "boilerplate-include": "Boilerplate include",
 "nested-include": "Nested include",
 "html-include": "HTML include",
 "include-from-another-markbind-site": "Include from another Markbind site",
 "feature-list": "Feature list"
 },

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view
 "title": "Hello World",
 "src": "index.md"
 },
 {
 "headings": {
 "popover-initiated-by-trigger-honor-trigger-attribute": "popover initiated by trigger: honor trigger attribute",
 "support-multiple-inclusions-of-a-modal": "Support multiple inclusions of a modal",
 "remove-extra-space-in-links": "Remove extra space in links"
 },
 "title": "Open Bugs",
 "src": "bugs/index.md"
 },
 {
 "headings": {
 "feature-list": "Feature list"
 },
 "src": "sub_site/index.md",
 "title": ""
 }
Expand Down

, '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('^' + ".*" + '

Skip to content
Support searching for headings#240

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 4 commits into

from

Jun 4, 2018
 Merged


Support searching for headings
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
12de50b

Page: Collect headings for siteData.json


nusjzx Jun 4, 2018
5c6b200

Search: Replace typeahead with searchbar


nusjzx Jun 4, 2018
fe5505e

Test: add headings in siteData.json


nusjzx Jun 4, 2018
12b0ed1

Docs: Replace typeahead with searchbar


nusjzx Jun 4, 2018

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


16 changes: 6 additions & 10 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,26 +10,22 @@ function setup() {
}

function setupWithSearch(siteData) {
 const { typeahead } = VueStrap.components;
 const { searchbar } = VueStrap.components;
 const vm = new Vue({
 el: '#app',
 components: {
typeahead,
searchbar,
 },
 data() {
 const helpers = {
 value() { return [this.title].concat(this.keywords).join(' '); },
 indexOf(query) { return this.value().indexOf(query); },
 toLowerCase() { return this.value().toLowerCase(); },
 };
 return {
 searchData: siteData.pages.map(page => Object.assign({}, page, helpers)),
 titleTemplate: '{{ item.title }}<br><sub>{{ item.keywords }}</sub>',
 searchData: siteData.pages,
 };
 },
 methods: {
 searchCallback(match) {
 window.location = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const page = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const anchor = match.heading ? `#${match.heading.id}` : '';
 window.location = `${page}${anchor}`;
 },
 },
 });
Expand Down

5 changes: 5 additions & 0 deletions
docs/common/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,9 @@
 <svg height="16px" fill="#777" class="octicon octicon-mark-github" viewBox="0 0 16 16" version="1.1" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path></svg>
 </a>
 </li>
 <li slot="right">
 <form class="navbar-form">
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
 </li>
</navbar>

4 changes: 2 additions & 2 deletions
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,15 +166,15 @@ In any file in your site, you can include the variable by surrounding the variab
To use the searchbar, add the following markup to your file.

```html
<typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead>
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
```

To use the searchbar within a navbar, add the following markup to your file. The searchbar can be positioned using the slot attribute for the list. The following markup adds a searchbar to the right side of the navbar with appropriate styling.

```html
<li slot="right">
 <form class="navbar-form">
 <typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead> 
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
</li>
```
Expand Down

14 changes: 14 additions & 0 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ function Page(pageConfig) {
 this.resultPath = pageConfig.resultPath;

 this.frontMatter = {};
 this.headings = {};
 this.includedFiles = {};
}

Expand DownExpand Up@@ -80,6 +81,18 @@ Page.prototype.prepareTemplateData = function () {
 };
};

/**
 * Records h1,h2,h3 headings into this.headings
 * @param renderedPage a page with its headings rendered
 */
Page.prototype.collectHeadings = function (renderedPage) {
 const $ = cheerio.load(renderedPage);
 $('h1,h2,h3').each((i, heading) => {
 this.headings[$(heading).attr('id')] = $(heading).text();
 });
 return renderedPage;
};

/**
 * 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@@ -153,6 +166,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.collectHeadings(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

5 changes: 4 additions & 1 deletion
lib/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,7 +507,10 @@ Site.prototype.copyMarkBindAsset = function () {
Site.prototype.writeSiteData = function () {
 return new Promise((resolve, reject) => {
 const siteDataPath = path.join(this.outputPath, SITE_DATA_NAME);
 const siteData = { pages: this.pages.map(page => (page.frontMatter)) };
 const siteData = {
 pages: this.pages.map(page => Object.assign({ headings: page.headings }, page.frontMatter)),
 };

 fs.outputJsonAsync(siteDataPath, siteData)
 .then(() => logger.info('Site data built'))
 .then(resolve)
Expand Down

19 changes: 19 additions & 0 deletions
test/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
{
 "pages": [
 {
 "headings": {
 "normal-include": "Normal include",
 "establishing-requirements": "Establishing Requirements",
 "include-segment": "Include segment",
 "dynamic-include": "Dynamic include",
 "boilerplate-include": "Boilerplate include",
 "nested-include": "Nested include",
 "html-include": "HTML include",
 "include-from-another-markbind-site": "Include from another Markbind site",
 "feature-list": "Feature list"
 },

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view
 "title": "Hello World",
 "src": "index.md"
 },
 {
 "headings": {
 "popover-initiated-by-trigger-honor-trigger-attribute": "popover initiated by trigger: honor trigger attribute",
 "support-multiple-inclusions-of-a-modal": "Support multiple inclusions of a modal",
 "remove-extra-space-in-links": "Remove extra space in links"
 },
 "title": "Open Bugs",
 "src": "bugs/index.md"
 },
 {
 "headings": {
 "feature-list": "Feature list"
 },
 "src": "sub_site/index.md",
 "title": ""
 }
Expand Down

, '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('^' + ".*" + '

Skip to content
Support searching for headings#240

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 4 commits into

from

Jun 4, 2018
 Merged


Support searching for headings
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
12de50b

Page: Collect headings for siteData.json


nusjzx Jun 4, 2018
5c6b200

Search: Replace typeahead with searchbar


nusjzx Jun 4, 2018
fe5505e

Test: add headings in siteData.json


nusjzx Jun 4, 2018
12b0ed1

Docs: Replace typeahead with searchbar


nusjzx Jun 4, 2018

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


16 changes: 6 additions & 10 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,26 +10,22 @@ function setup() {
}

function setupWithSearch(siteData) {
 const { typeahead } = VueStrap.components;
 const { searchbar } = VueStrap.components;
 const vm = new Vue({
 el: '#app',
 components: {
typeahead,
searchbar,
 },
 data() {
 const helpers = {
 value() { return [this.title].concat(this.keywords).join(' '); },
 indexOf(query) { return this.value().indexOf(query); },
 toLowerCase() { return this.value().toLowerCase(); },
 };
 return {
 searchData: siteData.pages.map(page => Object.assign({}, page, helpers)),
 titleTemplate: '{{ item.title }}<br><sub>{{ item.keywords }}</sub>',
 searchData: siteData.pages,
 };
 },
 methods: {
 searchCallback(match) {
 window.location = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const page = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const anchor = match.heading ? `#${match.heading.id}` : '';
 window.location = `${page}${anchor}`;
 },
 },
 });
Expand Down

5 changes: 5 additions & 0 deletions
docs/common/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,9 @@
 <svg height="16px" fill="#777" class="octicon octicon-mark-github" viewBox="0 0 16 16" version="1.1" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path></svg>
 </a>
 </li>
 <li slot="right">
 <form class="navbar-form">
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
 </li>
</navbar>

4 changes: 2 additions & 2 deletions
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,15 +166,15 @@ In any file in your site, you can include the variable by surrounding the variab
To use the searchbar, add the following markup to your file.

```html
<typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead>
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
```

To use the searchbar within a navbar, add the following markup to your file. The searchbar can be positioned using the slot attribute for the list. The following markup adds a searchbar to the right side of the navbar with appropriate styling.

```html
<li slot="right">
 <form class="navbar-form">
 <typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead> 
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
</li>
```
Expand Down

14 changes: 14 additions & 0 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ function Page(pageConfig) {
 this.resultPath = pageConfig.resultPath;

 this.frontMatter = {};
 this.headings = {};
 this.includedFiles = {};
}

Expand DownExpand Up@@ -80,6 +81,18 @@ Page.prototype.prepareTemplateData = function () {
 };
};

/**
 * Records h1,h2,h3 headings into this.headings
 * @param renderedPage a page with its headings rendered
 */
Page.prototype.collectHeadings = function (renderedPage) {
 const $ = cheerio.load(renderedPage);
 $('h1,h2,h3').each((i, heading) => {
 this.headings[$(heading).attr('id')] = $(heading).text();
 });
 return renderedPage;
};

/**
 * 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@@ -153,6 +166,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.collectHeadings(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

5 changes: 4 additions & 1 deletion
lib/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,7 +507,10 @@ Site.prototype.copyMarkBindAsset = function () {
Site.prototype.writeSiteData = function () {
 return new Promise((resolve, reject) => {
 const siteDataPath = path.join(this.outputPath, SITE_DATA_NAME);
 const siteData = { pages: this.pages.map(page => (page.frontMatter)) };
 const siteData = {
 pages: this.pages.map(page => Object.assign({ headings: page.headings }, page.frontMatter)),
 };

 fs.outputJsonAsync(siteDataPath, siteData)
 .then(() => logger.info('Site data built'))
 .then(resolve)
Expand Down

19 changes: 19 additions & 0 deletions
test/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
{
 "pages": [
 {
 "headings": {
 "normal-include": "Normal include",
 "establishing-requirements": "Establishing Requirements",
 "include-segment": "Include segment",
 "dynamic-include": "Dynamic include",
 "boilerplate-include": "Boilerplate include",
 "nested-include": "Nested include",
 "html-include": "HTML include",
 "include-from-another-markbind-site": "Include from another Markbind site",
 "feature-list": "Feature list"
 },

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view
 "title": "Hello World",
 "src": "index.md"
 },
 {
 "headings": {
 "popover-initiated-by-trigger-honor-trigger-attribute": "popover initiated by trigger: honor trigger attribute",
 "support-multiple-inclusions-of-a-modal": "Support multiple inclusions of a modal",
 "remove-extra-space-in-links": "Remove extra space in links"
 },
 "title": "Open Bugs",
 "src": "bugs/index.md"
 },
 {
 "headings": {
 "feature-list": "Feature list"
 },
 "src": "sub_site/index.md",
 "title": ""
 }
Expand Down

, '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); }
})();
})();

Skip to content
Support searching for headings#240

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 4 commits into

from

Jun 4, 2018
 Merged


Support searching for headings
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
12de50b

Page: Collect headings for siteData.json


nusjzx Jun 4, 2018
5c6b200

Search: Replace typeahead with searchbar


nusjzx Jun 4, 2018
fe5505e

Test: add headings in siteData.json


nusjzx Jun 4, 2018
12b0ed1

Docs: Replace typeahead with searchbar


nusjzx Jun 4, 2018

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


16 changes: 6 additions & 10 deletions
asset/js/setup.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,26 +10,22 @@ function setup() {
}

function setupWithSearch(siteData) {
 const { typeahead } = VueStrap.components;
 const { searchbar } = VueStrap.components;
 const vm = new Vue({
 el: '#app',
 components: {
typeahead,
searchbar,
 },
 data() {
 const helpers = {
 value() { return [this.title].concat(this.keywords).join(' '); },
 indexOf(query) { return this.value().indexOf(query); },
 toLowerCase() { return this.value().toLowerCase(); },
 };
 return {
 searchData: siteData.pages.map(page => Object.assign({}, page, helpers)),
 titleTemplate: '{{ item.title }}<br><sub>{{ item.keywords }}</sub>',
 searchData: siteData.pages,
 };
 },
 methods: {
 searchCallback(match) {
 window.location = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const page = `${baseUrl}/${match.src.replace('.md', '.html')}`;
 const anchor = match.heading ? `#${match.heading.id}` : '';
 window.location = `${page}${anchor}`;
 },
 },
 });
Expand Down

5 changes: 5 additions & 0 deletions
docs/common/header.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,9 @@
 <svg height="16px" fill="#777" class="octicon octicon-mark-github" viewBox="0 0 16 16" version="1.1" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path></svg>
 </a>
 </li>
 <li slot="right">
 <form class="navbar-form">
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
 </li>
</navbar>

4 changes: 2 additions & 2 deletions
docs/userGuide/contentAuthoring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,15 +166,15 @@ In any file in your site, you can include the variable by surrounding the variab
To use the searchbar, add the following markup to your file.

```html
<typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead>
<searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
```

To use the searchbar within a navbar, add the following markup to your file. The searchbar can be positioned using the slot attribute for the list. The following markup adds a searchbar to the right side of the navbar with appropriate styling.

```html
<li slot="right">
 <form class="navbar-form">
 <typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead> 
 <searchbar :data="searchData" placeholder="Search" :on-hit="searchCallback"></searchbar>
 </form>
</li>
```
Expand Down

14 changes: 14 additions & 0 deletions
lib/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ function Page(pageConfig) {
 this.resultPath = pageConfig.resultPath;

 this.frontMatter = {};
 this.headings = {};
 this.includedFiles = {};
}

Expand DownExpand Up@@ -80,6 +81,18 @@ Page.prototype.prepareTemplateData = function () {
 };
};

/**
 * Records h1,h2,h3 headings into this.headings
 * @param renderedPage a page with its headings rendered
 */
Page.prototype.collectHeadings = function (renderedPage) {
 const $ = cheerio.load(renderedPage);
 $('h1,h2,h3').each((i, heading) => {
 this.headings[$(heading).attr('id')] = $(heading).text();
 });
 return renderedPage;
};

/**
 * 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@@ -153,6 +166,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.collectHeadings(result))
 .then((result) => {
 this.content = htmlBeautify(result, { indent_size: 2 });

Expand Down

5 changes: 4 additions & 1 deletion
lib/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,7 +507,10 @@ Site.prototype.copyMarkBindAsset = function () {
Site.prototype.writeSiteData = function () {
 return new Promise((resolve, reject) => {
 const siteDataPath = path.join(this.outputPath, SITE_DATA_NAME);
 const siteData = { pages: this.pages.map(page => (page.frontMatter)) };
 const siteData = {
 pages: this.pages.map(page => Object.assign({ headings: page.headings }, page.frontMatter)),
 };

 fs.outputJsonAsync(siteDataPath, siteData)
 .then(() => logger.info('Site data built'))
 .then(resolve)
Expand Down

19 changes: 19 additions & 0 deletions
test/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
{
 "pages": [
 {
 "headings": {
 "normal-include": "Normal include",
 "establishing-requirements": "Establishing Requirements",
 "include-segment": "Include segment",
 "dynamic-include": "Dynamic include",
 "boilerplate-include": "Boilerplate include",
 "nested-include": "Nested include",
 "html-include": "HTML include",
 "include-from-another-markbind-site": "Include from another Markbind site",
 "feature-list": "Feature list"
 },

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view
 "title": "Hello World",
 "src": "index.md"
 },
 {
 "headings": {
 "popover-initiated-by-trigger-honor-trigger-attribute": "popover initiated by trigger: honor trigger attribute",
 "support-multiple-inclusions-of-a-modal": "Support multiple inclusions of a modal",
 "remove-extra-space-in-links": "Remove extra space in links"
 },
 "title": "Open Bugs",
 "src": "bugs/index.md"
 },
 {
 "headings": {
 "feature-list": "Feature list"
 },
 "src": "sub_site/index.md",
 "title": ""
 }
Expand Down