Skip to content

Allow an array of globs for the globs option#1118

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
marvinchin merged 1 commit into from
Mar 28, 2020
Merged

Allow an array of globs for the globs option #1118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions docs/dg-site.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,17 +3,11 @@
"titlePrefix": "MarkBind",
"pages": [
{
"glob": "**/*.mbd"
},
{
"glob": "*.md"
"glob": ["**/*.mbd", "*.md", "devGuide/*.md"]
},
{
"src": "index.md",
"searchable": "no"
},
{
"glob": "devGuide/*.md"
}
],
"headingIndexingLevel": 6,
Expand Down
30 changes: 7 additions & 23 deletions docs/site.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,32 +4,16 @@
"titlePrefix": "MarkBind",
"pages": [
{
"glob": "**/*.mbd"
"glob": ["**/*.mbd", "*.md", "userGuide/*.md", "devGuide/*.md"]
},
{
"glob": "*.md"
},
{
"src": "index.md",
"searchable": "no"
},
{
"glob": "userGuide/*.md"
},
{
"src": "userGuide/fullSyntaxReference.md",
"src": [
"index.md",
"userGuide/fullSyntaxReference.md",
"userGuide/syntaxCheatSheet.md",
"userGuide/readerFacingFeatures.md"
],
"searchable": "no"
},
{
"src": "userGuide/syntaxCheatSheet.md",
"searchable": "no"
},
{
"src": "userGuide/readerFacingFeatures.md",
"searchable": "no"
},
{
"glob": "devGuide/*.md"
}
],
"plugins" : [
Expand Down
27 changes: 7 additions & 20 deletions docs/ug-site.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,28 +3,15 @@
"titlePrefix": "MarkBind",
"pages": [
{
"glob": "**/*.mbd"
"glob": ["**/*.mbd", "*.md", "userGuide/*.md"]
},
{
"glob": "*.md"
},
{
"src": "index.md",
"searchable": "no"
},
{
"glob": "userGuide/*.md"
},
{
"src": "userGuide/fullSyntaxReference.md",
"searchable": "no"
},
{
"src": "userGuide/syntaxCheatSheet.md",
"searchable": "no"
},
{
"src": "userGuide/readerFacingFeatures.md",
"src": [
"index.md",
"userGuide/fullSyntaxReference.md",
"userGuide/syntaxCheatSheet.md",
"userGuide/readerFacingFeatures.md"
],
"searchable": "no"
}
],
Expand Down
7 changes: 5 additions & 2 deletions docs/userGuide/siteConfiguration.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,8 +98,11 @@ _(Optional)_ **The theme for the generated site.** Uses the default Bootstrap th

**An array of pages to be rendered.**

* **`src`**/**`glob`**: `src` can be used to specify a file e.g., `docs/index.md`.<br>
Alternatively, `glob` can be used to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)) e.g., `**/*.md`.
* **`src/glob`**
* `src` can be used to specify a single file, or an array of files.<br>
{{ icon_examples }} `docs/index.md` or `[ 'docs/index.md', 'docs/userGuide.md' ]` { .my-1 }
* `glob` can be used alternatively to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)), or an array of such file patterns.<br>
{{ icon_examples }} `**/*.md` or `[ '**/*.md', '**/*.mbdf' ]` { .my-2 }
* **`title`**: The page `<title>` for the generated web page. Titles specified here take priority over titles specified in the [front matter](addingPages.html#front-matter) of individual pages.
* **`layout`**: The [layout](tweakingThePageStructure.html#page-layouts) to be used by the page. Default: `default`.
* **`searchable`**: Specifies that the page(s) should be excluded from searching. Default: `yes`.
Expand Down
45 changes: 24 additions & 21 deletions src/Site.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ const injectMarkdownItSpecialTags = require(

const _ = {};
_.difference = require('lodash/difference');
_.flatMap = require('lodash/flatMap');
_.get = require('lodash/get');
_.has = require('lodash/has');
_.includes = require('lodash/includes');
Expand DownExpand Up@@ -442,36 +443,38 @@ class Site {
*/
collectAddressablePages() {
const { pages } = this.siteConfig;
const addressableGlobs = pages.filter(page => page.glob);
this.addressablePages = pages.filter(page => page.src);
const pagesFromSrc = _.flatMap(pages.filter(page => page.src), page => (Array.isArray(page.src)
? page.src.map(pageSrc => ({ ...page, src: pageSrc }))
: [page]));

@ang-zeyuang-zeyuMar 28, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Thanks for the feedback and reviews! @yash-chowdhary@damithc@marvinchin

Yeah, this looks good to me 🚀 Supporting an array of src sounds great as well! Let's do it in another PR?

My bad, pushed this before seeing this message. Its just a three line change here ^ though, let me know if it should be in a separate PR!

@yash-chowdharyyash-chowdharyMar 28, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Its just a three line change here ^ though, let me know if it should be in a separate PR!

I think it can be left in this PR. 👍

const set = new Set();
const duplicatePages = this.addressablePages
const duplicatePages = pagesFromSrc
.filter(page => set.size === set.add(page.src).size)
.map(page => page.src);
if (duplicatePages.length > 0) {
return Promise.reject(
new Error(`Duplicate page entries found in site config: ${_.uniq(duplicatePages).join(', ')}`));
}
const globPaths = addressableGlobs.reduce((globPages, addressableGlob) =>
globPages.concat(walkSync(this.rootPath, {
directories: false,
globs: [addressableGlob.glob],
ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
}).map(globPath => ({
src: globPath,
searchable: addressableGlob.searchable,
layout: addressableGlob.layout,
frontmatter: addressableGlob.frontmatter,
}))), []);
// Add pages collected by walkSync and merge properties for pages
const pagesFromGlobs = _.flatMap(pages.filter(page => page.glob), page => walkSync(this.rootPath, {
directories: false,
globs: Array.isArray(page.glob) ? page.glob : [page.glob],
ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
}).map(filePath => ({
src: filePath,
searchable: page.searchable,
layout: page.layout,
frontmatter: page.frontmatter,
})));
/*
Add pages collected from globs and merge properties for pages
Page properties collected from src have priority over page properties from globs,
while page properties from later entries take priority over earlier ones.
*/
const filteredPages = {};
globPaths.concat(this.addressablePages).forEach((page) => {
pagesFromGlobs.concat(pagesFromSrc).forEach((page) => {
const filteredPage = _.omitBy(page, _.isUndefined);
if (page.src in filteredPages) {
filteredPages[page.src] = { ...filteredPages[page.src], ...filteredPage };
} else {
filteredPages[page.src] = filteredPage;
}
filteredPages[page.src] = page.src in filteredPages
? { ...filteredPages[page.src], ...filteredPage }
: filteredPage;
});
this.addressablePages = Object.values(filteredPages);

Expand Down
5 changes: 1 addition & 4 deletions src/template/default/site.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,7 @@
"title": "Landing Page"
},
{
"glob": "**/index.md"
},
{
"glob": "**/*.+(md|mbd)"
"glob": ["**/index.md", "**/*.+(md|mbd)"]
}
],
"deploy": {
Expand Down
8 changes: 2 additions & 6 deletions src/template/minimal/site.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,14 +18,10 @@
"title": "Hello World"
},
{
"glob": "**/index.md"
},
{
"glob": "**/*.+(md|mbd)"
"glob": ["**/index.md", "**/*.+(md|mbd)"]
}
],
"deploy": {
"message": "Site Update."
}
}

}
12 changes: 6 additions & 6 deletions test/functional/test_site/expected/siteData.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -152,19 +152,19 @@
"headingKeywords": {}
},
{
"src": "testExternalScripts.md",
"title": "Hello World",
"layout": "default",
"head": "overwriteLayoutHead.md",
"layout": "testLayout",
"src": "testLayoutsOverride.md",
"globalOverrideProperty": "Overridden by global override",
"globalAndFrontMatterOverrideProperty": "Overridden by global override",
"headings": {},
"headingKeywords": {}
},
{
"src": "testExternalScripts.md",
"title": "Hello World",
"head": "overwriteLayoutHead.md",
"layout": "testLayout",
"src": "testLayouts.md",
"layout": "default",
"globalOverrideProperty": "Overridden by global override",
"globalAndFrontMatterOverrideProperty": "Overridden by global override",
"headings": {},
Expand All@@ -174,7 +174,7 @@
"title": "Hello World",
"head": "overwriteLayoutHead.md",
"layout": "testLayout",
"src": "testLayoutsOverride.md",
"src": "testLayouts.md",
"globalOverrideProperty": "Overridden by global override",
"globalAndFrontMatterOverrideProperty": "Overridden by global override",
"headings": {},
Expand Down
12 changes: 2 additions & 10 deletions test/functional/test_site/site.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@
"layout": "testAfterSetup"
},
{
"src": "testEmptyFrontmatter.md",
"src": ["testEmptyFrontmatter.md", "testLayoutsOverride.md"],
"title": "Hello World",
"layout": "testLayout"
},
Expand All@@ -34,15 +34,7 @@
"title": "Hello World"
},
{
"src": "testLayoutsOverride.md",
"title": "Hello World",
"layout": "testLayout"
},
{
"glob": "**/index.md"
},
{
"glob": "**/test_md_fragment.md"
"glob": ["**/index.md", "**/test_md_fragment.md"]
},
{
"src": "testAntiFOUCStyles.md",
Expand Down
14 changes: 7 additions & 7 deletions test/functional/test_site_convert/expected/siteData.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
{
"enableSearch": true,
"pages": [
{
"src": "index.md",
"title": "Landing Page",
"layout": "default",
"headings": {},
"headingKeywords": {}
},
{
"src": "Home.md",
"title": "",
Expand DownExpand Up@@ -84,6 +77,13 @@
"layout": "default",
"headings": {},
"headingKeywords": {}
},
{
"src": "index.md",
"title": "Landing Page",
"layout": "default",
"headings": {},
"headingKeywords": {}
}
]
}
34 changes: 17 additions & 17 deletions test/functional/test_site_templates/test_default/expected/siteData.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,6 @@
{
"enableSearch": true,
"pages": [
{
"header": "header.md",
"pageNav": 2,
"pageNavTitle": "Chapters of This Page",
"siteNav": "site-nav.md",
"src": "index.md",
"title": "Landing Page",
"layout": "default",
"headings": {
"heading-1": "Heading 1",
"sub-heading-1-1": "Sub Heading 1.1",
"sub-heading-1-2": "Sub Heading 1.2",
"heading-2": "Heading 2",
"heading-3": "Heading 3"
},
"headingKeywords": {}
},
{
"header": "header.md",
"siteNav": "site-nav.md",
Expand DownExpand Up@@ -55,6 +38,23 @@
"layout": "default",
"headings": {},
"headingKeywords": {}
},
{
"header": "header.md",
"pageNav": 2,
"pageNavTitle": "Chapters of This Page",
"siteNav": "site-nav.md",
"src": "index.md",
"title": "Landing Page",
"layout": "default",
"headings": {
"heading-1": "Heading 1",
"sub-heading-1-1": "Sub Heading 1.1",
"sub-heading-1-2": "Sub Heading 1.2",
"heading-2": "Heading 2",
"heading-3": "Heading 3"
},
"headingKeywords": {}
}
]
}
, '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" + '
Allow an array of globs for the globs option by ang-zeyu · Pull Request #1118 · MarkBind/markbind · GitHub
Skip to content
Allow an array of globs for the globs option#1118

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

marvinchin
merged 1 commit into

from

Mar 28, 2020
 Merged


Allow an array of globs for the globs option
#1118
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 1 addition & 7 deletions
docs/dg-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,17 +3,11 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 },
 {
 "glob": "*.md"
 "glob": ["**/*.mbd", "*.md", "devGuide/*.md"]
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "headingIndexingLevel": 6,
Expand Down

30 changes: 7 additions & 23 deletions
docs/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,32 +4,16 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md", "devGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "plugins" : [
Expand Down

27 changes: 7 additions & 20 deletions
docs/ug-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,28 +3,15 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 }
 ],
Expand Down

7 changes: 5 additions & 2 deletions
docs/userGuide/siteConfiguration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,8 +98,11 @@ _(Optional)_ **The theme for the generated site.** Uses the default Bootstrap th

**An array of pages to be rendered.**

* **`src`**/**`glob`**: `src` can be used to specify a file e.g., `docs/index.md`.<br>
 Alternatively, `glob` can be used to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)) e.g., `**/*.md`.
* **`src/glob`**
 * `src` can be used to specify a single file, or an array of files.<br>
 {{ icon_examples }} `docs/index.md` or `[ 'docs/index.md', 'docs/userGuide.md' ]` { .my-1 }
 * `glob` can be used alternatively to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)), or an array of such file patterns.<br>
 {{ icon_examples }} `**/*.md` or `[ '**/*.md', '**/*.mbdf' ]` { .my-2 }
* **`title`**: The page `<title>` for the generated web page. Titles specified here take priority over titles specified in the [front matter](addingPages.html#front-matter) of individual pages.
* **`layout`**: The [layout](tweakingThePageStructure.html#page-layouts) to be used by the page. Default: `default`.
* **`searchable`**: Specifies that the page(s) should be excluded from searching. Default: `yes`.
Expand Down

45 changes: 24 additions & 21 deletions
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ const injectMarkdownItSpecialTags = require(

const _ = {};
_.difference = require('lodash/difference');
_.flatMap = require('lodash/flatMap');
_.get = require('lodash/get');
_.has = require('lodash/has');
_.includes = require('lodash/includes');
Expand DownExpand Up@@ -442,36 +443,38 @@ class Site {
 */
 collectAddressablePages() {
 const { pages } = this.siteConfig;
 const addressableGlobs = pages.filter(page => page.glob);
 this.addressablePages = pages.filter(page => page.src);
 const pagesFromSrc = _.flatMap(pages.filter(page => page.src), page => (Array.isArray(page.src)
 ? page.src.map(pageSrc => ({ ...page, src: pageSrc }))
 : [page]));
@ang-zeyuang-zeyuMar 28, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks for the feedback and reviews! @yash-chowdhary@damithc@marvinchin
Yeah, this looks good to me 🚀 Supporting an array of src sounds great as well! Let's do it in another PR?
My bad, pushed this before seeing this message. Its just a three line change here ^ though, let me know if it should be in a separate PR!
@yash-chowdharyyash-chowdharyMar 28, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Its just a three line change here ^ though, let me know if it should be in a separate PR!
I think it can be left in this PR. 👍
 const set = new Set();
 const duplicatePages = this.addressablePages
 const duplicatePages = pagesFromSrc
 .filter(page => set.size === set.add(page.src).size)
 .map(page => page.src);
 if (duplicatePages.length > 0) {
 return Promise.reject(
 new Error(`Duplicate page entries found in site config: ${_.uniq(duplicatePages).join(', ')}`));
 }
 const globPaths = addressableGlobs.reduce((globPages, addressableGlob) =>
 globPages.concat(walkSync(this.rootPath, {
 directories: false,
 globs: [addressableGlob.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(globPath => ({
 src: globPath,
 searchable: addressableGlob.searchable,
 layout: addressableGlob.layout,
 frontmatter: addressableGlob.frontmatter,
 }))), []);
 // Add pages collected by walkSync and merge properties for pages
 const pagesFromGlobs = _.flatMap(pages.filter(page => page.glob), page => walkSync(this.rootPath, {
 directories: false,
 globs: Array.isArray(page.glob) ? page.glob : [page.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(filePath => ({
 src: filePath,
 searchable: page.searchable,
 layout: page.layout,
 frontmatter: page.frontmatter,
 })));
 /*
 Add pages collected from globs and merge properties for pages
 Page properties collected from src have priority over page properties from globs,
 while page properties from later entries take priority over earlier ones.
 */
 const filteredPages = {};
globPaths.concat(this.addressablePages).forEach((page) => {
pagesFromGlobs.concat(pagesFromSrc).forEach((page) => {
 const filteredPage = _.omitBy(page, _.isUndefined);
 if (page.src in filteredPages) {
 filteredPages[page.src] = { ...filteredPages[page.src], ...filteredPage };
 } else {
 filteredPages[page.src] = filteredPage;
 }
 filteredPages[page.src] = page.src in filteredPages
 ? { ...filteredPages[page.src], ...filteredPage }
 : filteredPage;
 });
 this.addressablePages = Object.values(filteredPages);

Expand Down

5 changes: 1 addition & 4 deletions
src/template/default/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,7 @@
 "title": "Landing Page"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
Expand Down

8 changes: 2 additions & 6 deletions
src/template/minimal/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,14 +18,10 @@
 "title": "Hello World"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
 "message": "Site Update."
 }
 }

}

12 changes: 6 additions & 6 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,19 +152,19 @@
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "layout": "default",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayouts.md",
 "layout": "default",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand All@@ -174,7 +174,7 @@
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "src": "testLayouts.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand Down

12 changes: 2 additions & 10 deletions
test/functional/test_site/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@
 "layout": "testAfterSetup"
 },
 {
 "src": "testEmptyFrontmatter.md",
 "src": ["testEmptyFrontmatter.md", "testLayoutsOverride.md"],
 "title": "Hello World",
 "layout": "testLayout"
 },
Expand All@@ -34,15 +34,7 @@
 "title": "Hello World"
 },
 {
 "src": "testLayoutsOverride.md",
 "title": "Hello World",
 "layout": "testLayout"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/test_md_fragment.md"
 "glob": ["**/index.md", "**/test_md_fragment.md"]
 },
 {
 "src": "testAntiFOUCStyles.md",
Expand Down

14 changes: 7 additions & 7 deletions
test/functional/test_site_convert/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "Home.md",
 "title": "",
Expand DownExpand Up@@ -84,6 +77,13 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 }
 ]
}

34 changes: 17 additions & 17 deletions
test/functional/test_site_templates/test_default/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "siteNav": "site-nav.md",
Expand DownExpand Up@@ -55,6 +38,23 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 }
 ]
}

, '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('^' + ".*" + '
Allow an array of globs for the globs option by ang-zeyu · Pull Request #1118 · MarkBind/markbind · GitHub
Skip to content
Allow an array of globs for the globs option#1118

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

marvinchin
merged 1 commit into

from

Mar 28, 2020
 Merged


Allow an array of globs for the globs option
#1118
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 1 addition & 7 deletions
docs/dg-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,17 +3,11 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 },
 {
 "glob": "*.md"
 "glob": ["**/*.mbd", "*.md", "devGuide/*.md"]
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "headingIndexingLevel": 6,
Expand Down

30 changes: 7 additions & 23 deletions
docs/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,32 +4,16 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md", "devGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "plugins" : [
Expand Down

27 changes: 7 additions & 20 deletions
docs/ug-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,28 +3,15 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 }
 ],
Expand Down

7 changes: 5 additions & 2 deletions
docs/userGuide/siteConfiguration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,8 +98,11 @@ _(Optional)_ **The theme for the generated site.** Uses the default Bootstrap th

**An array of pages to be rendered.**

* **`src`**/**`glob`**: `src` can be used to specify a file e.g., `docs/index.md`.<br>
 Alternatively, `glob` can be used to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)) e.g., `**/*.md`.
* **`src/glob`**
 * `src` can be used to specify a single file, or an array of files.<br>
 {{ icon_examples }} `docs/index.md` or `[ 'docs/index.md', 'docs/userGuide.md' ]` { .my-1 }
 * `glob` can be used alternatively to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)), or an array of such file patterns.<br>
 {{ icon_examples }} `**/*.md` or `[ '**/*.md', '**/*.mbdf' ]` { .my-2 }
* **`title`**: The page `<title>` for the generated web page. Titles specified here take priority over titles specified in the [front matter](addingPages.html#front-matter) of individual pages.
* **`layout`**: The [layout](tweakingThePageStructure.html#page-layouts) to be used by the page. Default: `default`.
* **`searchable`**: Specifies that the page(s) should be excluded from searching. Default: `yes`.
Expand Down

45 changes: 24 additions & 21 deletions
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ const injectMarkdownItSpecialTags = require(

const _ = {};
_.difference = require('lodash/difference');
_.flatMap = require('lodash/flatMap');
_.get = require('lodash/get');
_.has = require('lodash/has');
_.includes = require('lodash/includes');
Expand DownExpand Up@@ -442,36 +443,38 @@ class Site {
 */
 collectAddressablePages() {
 const { pages } = this.siteConfig;
 const addressableGlobs = pages.filter(page => page.glob);
 this.addressablePages = pages.filter(page => page.src);
 const pagesFromSrc = _.flatMap(pages.filter(page => page.src), page => (Array.isArray(page.src)
 ? page.src.map(pageSrc => ({ ...page, src: pageSrc }))
 : [page]));
@ang-zeyuang-zeyuMar 28, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks for the feedback and reviews! @yash-chowdhary@damithc@marvinchin
Yeah, this looks good to me 🚀 Supporting an array of src sounds great as well! Let's do it in another PR?
My bad, pushed this before seeing this message. Its just a three line change here ^ though, let me know if it should be in a separate PR!
@yash-chowdharyyash-chowdharyMar 28, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Its just a three line change here ^ though, let me know if it should be in a separate PR!
I think it can be left in this PR. 👍
 const set = new Set();
 const duplicatePages = this.addressablePages
 const duplicatePages = pagesFromSrc
 .filter(page => set.size === set.add(page.src).size)
 .map(page => page.src);
 if (duplicatePages.length > 0) {
 return Promise.reject(
 new Error(`Duplicate page entries found in site config: ${_.uniq(duplicatePages).join(', ')}`));
 }
 const globPaths = addressableGlobs.reduce((globPages, addressableGlob) =>
 globPages.concat(walkSync(this.rootPath, {
 directories: false,
 globs: [addressableGlob.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(globPath => ({
 src: globPath,
 searchable: addressableGlob.searchable,
 layout: addressableGlob.layout,
 frontmatter: addressableGlob.frontmatter,
 }))), []);
 // Add pages collected by walkSync and merge properties for pages
 const pagesFromGlobs = _.flatMap(pages.filter(page => page.glob), page => walkSync(this.rootPath, {
 directories: false,
 globs: Array.isArray(page.glob) ? page.glob : [page.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(filePath => ({
 src: filePath,
 searchable: page.searchable,
 layout: page.layout,
 frontmatter: page.frontmatter,
 })));
 /*
 Add pages collected from globs and merge properties for pages
 Page properties collected from src have priority over page properties from globs,
 while page properties from later entries take priority over earlier ones.
 */
 const filteredPages = {};
globPaths.concat(this.addressablePages).forEach((page) => {
pagesFromGlobs.concat(pagesFromSrc).forEach((page) => {
 const filteredPage = _.omitBy(page, _.isUndefined);
 if (page.src in filteredPages) {
 filteredPages[page.src] = { ...filteredPages[page.src], ...filteredPage };
 } else {
 filteredPages[page.src] = filteredPage;
 }
 filteredPages[page.src] = page.src in filteredPages
 ? { ...filteredPages[page.src], ...filteredPage }
 : filteredPage;
 });
 this.addressablePages = Object.values(filteredPages);

Expand Down

5 changes: 1 addition & 4 deletions
src/template/default/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,7 @@
 "title": "Landing Page"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
Expand Down

8 changes: 2 additions & 6 deletions
src/template/minimal/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,14 +18,10 @@
 "title": "Hello World"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
 "message": "Site Update."
 }
 }

}

12 changes: 6 additions & 6 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,19 +152,19 @@
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "layout": "default",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayouts.md",
 "layout": "default",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand All@@ -174,7 +174,7 @@
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "src": "testLayouts.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand Down

12 changes: 2 additions & 10 deletions
test/functional/test_site/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@
 "layout": "testAfterSetup"
 },
 {
 "src": "testEmptyFrontmatter.md",
 "src": ["testEmptyFrontmatter.md", "testLayoutsOverride.md"],
 "title": "Hello World",
 "layout": "testLayout"
 },
Expand All@@ -34,15 +34,7 @@
 "title": "Hello World"
 },
 {
 "src": "testLayoutsOverride.md",
 "title": "Hello World",
 "layout": "testLayout"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/test_md_fragment.md"
 "glob": ["**/index.md", "**/test_md_fragment.md"]
 },
 {
 "src": "testAntiFOUCStyles.md",
Expand Down

14 changes: 7 additions & 7 deletions
test/functional/test_site_convert/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "Home.md",
 "title": "",
Expand DownExpand Up@@ -84,6 +77,13 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 }
 ]
}

34 changes: 17 additions & 17 deletions
test/functional/test_site_templates/test_default/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "siteNav": "site-nav.md",
Expand DownExpand Up@@ -55,6 +38,23 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 }
 ]
}

, '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('^' + ".*" + '
Allow an array of globs for the globs option by ang-zeyu · Pull Request #1118 · MarkBind/markbind · GitHub
Skip to content
Allow an array of globs for the globs option#1118

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

marvinchin
merged 1 commit into

from

Mar 28, 2020
 Merged


Allow an array of globs for the globs option
#1118
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 1 addition & 7 deletions
docs/dg-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,17 +3,11 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 },
 {
 "glob": "*.md"
 "glob": ["**/*.mbd", "*.md", "devGuide/*.md"]
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "headingIndexingLevel": 6,
Expand Down

30 changes: 7 additions & 23 deletions
docs/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,32 +4,16 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md", "devGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "plugins" : [
Expand Down

27 changes: 7 additions & 20 deletions
docs/ug-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,28 +3,15 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 }
 ],
Expand Down

7 changes: 5 additions & 2 deletions
docs/userGuide/siteConfiguration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,8 +98,11 @@ _(Optional)_ **The theme for the generated site.** Uses the default Bootstrap th

**An array of pages to be rendered.**

* **`src`**/**`glob`**: `src` can be used to specify a file e.g., `docs/index.md`.<br>
 Alternatively, `glob` can be used to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)) e.g., `**/*.md`.
* **`src/glob`**
 * `src` can be used to specify a single file, or an array of files.<br>
 {{ icon_examples }} `docs/index.md` or `[ 'docs/index.md', 'docs/userGuide.md' ]` { .my-1 }
 * `glob` can be used alternatively to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)), or an array of such file patterns.<br>
 {{ icon_examples }} `**/*.md` or `[ '**/*.md', '**/*.mbdf' ]` { .my-2 }
* **`title`**: The page `<title>` for the generated web page. Titles specified here take priority over titles specified in the [front matter](addingPages.html#front-matter) of individual pages.
* **`layout`**: The [layout](tweakingThePageStructure.html#page-layouts) to be used by the page. Default: `default`.
* **`searchable`**: Specifies that the page(s) should be excluded from searching. Default: `yes`.
Expand Down

45 changes: 24 additions & 21 deletions
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ const injectMarkdownItSpecialTags = require(

const _ = {};
_.difference = require('lodash/difference');
_.flatMap = require('lodash/flatMap');
_.get = require('lodash/get');
_.has = require('lodash/has');
_.includes = require('lodash/includes');
Expand DownExpand Up@@ -442,36 +443,38 @@ class Site {
 */
 collectAddressablePages() {
 const { pages } = this.siteConfig;
 const addressableGlobs = pages.filter(page => page.glob);
 this.addressablePages = pages.filter(page => page.src);
 const pagesFromSrc = _.flatMap(pages.filter(page => page.src), page => (Array.isArray(page.src)
 ? page.src.map(pageSrc => ({ ...page, src: pageSrc }))
 : [page]));
@ang-zeyuang-zeyuMar 28, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks for the feedback and reviews! @yash-chowdhary@damithc@marvinchin
Yeah, this looks good to me 🚀 Supporting an array of src sounds great as well! Let's do it in another PR?
My bad, pushed this before seeing this message. Its just a three line change here ^ though, let me know if it should be in a separate PR!
@yash-chowdharyyash-chowdharyMar 28, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Its just a three line change here ^ though, let me know if it should be in a separate PR!
I think it can be left in this PR. 👍
 const set = new Set();
 const duplicatePages = this.addressablePages
 const duplicatePages = pagesFromSrc
 .filter(page => set.size === set.add(page.src).size)
 .map(page => page.src);
 if (duplicatePages.length > 0) {
 return Promise.reject(
 new Error(`Duplicate page entries found in site config: ${_.uniq(duplicatePages).join(', ')}`));
 }
 const globPaths = addressableGlobs.reduce((globPages, addressableGlob) =>
 globPages.concat(walkSync(this.rootPath, {
 directories: false,
 globs: [addressableGlob.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(globPath => ({
 src: globPath,
 searchable: addressableGlob.searchable,
 layout: addressableGlob.layout,
 frontmatter: addressableGlob.frontmatter,
 }))), []);
 // Add pages collected by walkSync and merge properties for pages
 const pagesFromGlobs = _.flatMap(pages.filter(page => page.glob), page => walkSync(this.rootPath, {
 directories: false,
 globs: Array.isArray(page.glob) ? page.glob : [page.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(filePath => ({
 src: filePath,
 searchable: page.searchable,
 layout: page.layout,
 frontmatter: page.frontmatter,
 })));
 /*
 Add pages collected from globs and merge properties for pages
 Page properties collected from src have priority over page properties from globs,
 while page properties from later entries take priority over earlier ones.
 */
 const filteredPages = {};
globPaths.concat(this.addressablePages).forEach((page) => {
pagesFromGlobs.concat(pagesFromSrc).forEach((page) => {
 const filteredPage = _.omitBy(page, _.isUndefined);
 if (page.src in filteredPages) {
 filteredPages[page.src] = { ...filteredPages[page.src], ...filteredPage };
 } else {
 filteredPages[page.src] = filteredPage;
 }
 filteredPages[page.src] = page.src in filteredPages
 ? { ...filteredPages[page.src], ...filteredPage }
 : filteredPage;
 });
 this.addressablePages = Object.values(filteredPages);

Expand Down

5 changes: 1 addition & 4 deletions
src/template/default/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,7 @@
 "title": "Landing Page"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
Expand Down

8 changes: 2 additions & 6 deletions
src/template/minimal/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,14 +18,10 @@
 "title": "Hello World"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
 "message": "Site Update."
 }
 }

}

12 changes: 6 additions & 6 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,19 +152,19 @@
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "layout": "default",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayouts.md",
 "layout": "default",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand All@@ -174,7 +174,7 @@
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "src": "testLayouts.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand Down

12 changes: 2 additions & 10 deletions
test/functional/test_site/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@
 "layout": "testAfterSetup"
 },
 {
 "src": "testEmptyFrontmatter.md",
 "src": ["testEmptyFrontmatter.md", "testLayoutsOverride.md"],
 "title": "Hello World",
 "layout": "testLayout"
 },
Expand All@@ -34,15 +34,7 @@
 "title": "Hello World"
 },
 {
 "src": "testLayoutsOverride.md",
 "title": "Hello World",
 "layout": "testLayout"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/test_md_fragment.md"
 "glob": ["**/index.md", "**/test_md_fragment.md"]
 },
 {
 "src": "testAntiFOUCStyles.md",
Expand Down

14 changes: 7 additions & 7 deletions
test/functional/test_site_convert/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "Home.md",
 "title": "",
Expand DownExpand Up@@ -84,6 +77,13 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 }
 ]
}

34 changes: 17 additions & 17 deletions
test/functional/test_site_templates/test_default/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "siteNav": "site-nav.md",
Expand DownExpand Up@@ -55,6 +38,23 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 }
 ]
}

, '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" + '
Allow an array of globs for the globs option by ang-zeyu · Pull Request #1118 · MarkBind/markbind · GitHub
Skip to content
Allow an array of globs for the globs option#1118

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

marvinchin
merged 1 commit into

from

Mar 28, 2020
 Merged


Allow an array of globs for the globs option
#1118
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 1 addition & 7 deletions
docs/dg-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,17 +3,11 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 },
 {
 "glob": "*.md"
 "glob": ["**/*.mbd", "*.md", "devGuide/*.md"]
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "headingIndexingLevel": 6,
Expand Down

30 changes: 7 additions & 23 deletions
docs/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,32 +4,16 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md", "devGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "plugins" : [
Expand Down

27 changes: 7 additions & 20 deletions
docs/ug-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,28 +3,15 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 }
 ],
Expand Down

7 changes: 5 additions & 2 deletions
docs/userGuide/siteConfiguration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,8 +98,11 @@ _(Optional)_ **The theme for the generated site.** Uses the default Bootstrap th

**An array of pages to be rendered.**

* **`src`**/**`glob`**: `src` can be used to specify a file e.g., `docs/index.md`.<br>
 Alternatively, `glob` can be used to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)) e.g., `**/*.md`.
* **`src/glob`**
 * `src` can be used to specify a single file, or an array of files.<br>
 {{ icon_examples }} `docs/index.md` or `[ 'docs/index.md', 'docs/userGuide.md' ]` { .my-1 }
 * `glob` can be used alternatively to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)), or an array of such file patterns.<br>
 {{ icon_examples }} `**/*.md` or `[ '**/*.md', '**/*.mbdf' ]` { .my-2 }
* **`title`**: The page `<title>` for the generated web page. Titles specified here take priority over titles specified in the [front matter](addingPages.html#front-matter) of individual pages.
* **`layout`**: The [layout](tweakingThePageStructure.html#page-layouts) to be used by the page. Default: `default`.
* **`searchable`**: Specifies that the page(s) should be excluded from searching. Default: `yes`.
Expand Down

45 changes: 24 additions & 21 deletions
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ const injectMarkdownItSpecialTags = require(

const _ = {};
_.difference = require('lodash/difference');
_.flatMap = require('lodash/flatMap');
_.get = require('lodash/get');
_.has = require('lodash/has');
_.includes = require('lodash/includes');
Expand DownExpand Up@@ -442,36 +443,38 @@ class Site {
 */
 collectAddressablePages() {
 const { pages } = this.siteConfig;
 const addressableGlobs = pages.filter(page => page.glob);
 this.addressablePages = pages.filter(page => page.src);
 const pagesFromSrc = _.flatMap(pages.filter(page => page.src), page => (Array.isArray(page.src)
 ? page.src.map(pageSrc => ({ ...page, src: pageSrc }))
 : [page]));
@ang-zeyuang-zeyuMar 28, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks for the feedback and reviews! @yash-chowdhary@damithc@marvinchin
Yeah, this looks good to me 🚀 Supporting an array of src sounds great as well! Let's do it in another PR?
My bad, pushed this before seeing this message. Its just a three line change here ^ though, let me know if it should be in a separate PR!
@yash-chowdharyyash-chowdharyMar 28, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Its just a three line change here ^ though, let me know if it should be in a separate PR!
I think it can be left in this PR. 👍
 const set = new Set();
 const duplicatePages = this.addressablePages
 const duplicatePages = pagesFromSrc
 .filter(page => set.size === set.add(page.src).size)
 .map(page => page.src);
 if (duplicatePages.length > 0) {
 return Promise.reject(
 new Error(`Duplicate page entries found in site config: ${_.uniq(duplicatePages).join(', ')}`));
 }
 const globPaths = addressableGlobs.reduce((globPages, addressableGlob) =>
 globPages.concat(walkSync(this.rootPath, {
 directories: false,
 globs: [addressableGlob.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(globPath => ({
 src: globPath,
 searchable: addressableGlob.searchable,
 layout: addressableGlob.layout,
 frontmatter: addressableGlob.frontmatter,
 }))), []);
 // Add pages collected by walkSync and merge properties for pages
 const pagesFromGlobs = _.flatMap(pages.filter(page => page.glob), page => walkSync(this.rootPath, {
 directories: false,
 globs: Array.isArray(page.glob) ? page.glob : [page.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(filePath => ({
 src: filePath,
 searchable: page.searchable,
 layout: page.layout,
 frontmatter: page.frontmatter,
 })));
 /*
 Add pages collected from globs and merge properties for pages
 Page properties collected from src have priority over page properties from globs,
 while page properties from later entries take priority over earlier ones.
 */
 const filteredPages = {};
globPaths.concat(this.addressablePages).forEach((page) => {
pagesFromGlobs.concat(pagesFromSrc).forEach((page) => {
 const filteredPage = _.omitBy(page, _.isUndefined);
 if (page.src in filteredPages) {
 filteredPages[page.src] = { ...filteredPages[page.src], ...filteredPage };
 } else {
 filteredPages[page.src] = filteredPage;
 }
 filteredPages[page.src] = page.src in filteredPages
 ? { ...filteredPages[page.src], ...filteredPage }
 : filteredPage;
 });
 this.addressablePages = Object.values(filteredPages);

Expand Down

5 changes: 1 addition & 4 deletions
src/template/default/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,7 @@
 "title": "Landing Page"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
Expand Down

8 changes: 2 additions & 6 deletions
src/template/minimal/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,14 +18,10 @@
 "title": "Hello World"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
 "message": "Site Update."
 }
 }

}

12 changes: 6 additions & 6 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,19 +152,19 @@
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "layout": "default",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayouts.md",
 "layout": "default",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand All@@ -174,7 +174,7 @@
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "src": "testLayouts.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand Down

12 changes: 2 additions & 10 deletions
test/functional/test_site/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@
 "layout": "testAfterSetup"
 },
 {
 "src": "testEmptyFrontmatter.md",
 "src": ["testEmptyFrontmatter.md", "testLayoutsOverride.md"],
 "title": "Hello World",
 "layout": "testLayout"
 },
Expand All@@ -34,15 +34,7 @@
 "title": "Hello World"
 },
 {
 "src": "testLayoutsOverride.md",
 "title": "Hello World",
 "layout": "testLayout"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/test_md_fragment.md"
 "glob": ["**/index.md", "**/test_md_fragment.md"]
 },
 {
 "src": "testAntiFOUCStyles.md",
Expand Down

14 changes: 7 additions & 7 deletions
test/functional/test_site_convert/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "Home.md",
 "title": "",
Expand DownExpand Up@@ -84,6 +77,13 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 }
 ]
}

34 changes: 17 additions & 17 deletions
test/functional/test_site_templates/test_default/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "siteNav": "site-nav.md",
Expand DownExpand Up@@ -55,6 +38,23 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 }
 ]
}

, '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('^' + ".*" + '
Allow an array of globs for the globs option by ang-zeyu · Pull Request #1118 · MarkBind/markbind · GitHub
Skip to content
Allow an array of globs for the globs option#1118

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

marvinchin
merged 1 commit into

from

Mar 28, 2020
 Merged


Allow an array of globs for the globs option
#1118
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 1 addition & 7 deletions
docs/dg-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,17 +3,11 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 },
 {
 "glob": "*.md"
 "glob": ["**/*.mbd", "*.md", "devGuide/*.md"]
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "headingIndexingLevel": 6,
Expand Down

30 changes: 7 additions & 23 deletions
docs/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,32 +4,16 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md", "devGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "plugins" : [
Expand Down

27 changes: 7 additions & 20 deletions
docs/ug-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,28 +3,15 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 }
 ],
Expand Down

7 changes: 5 additions & 2 deletions
docs/userGuide/siteConfiguration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,8 +98,11 @@ _(Optional)_ **The theme for the generated site.** Uses the default Bootstrap th

**An array of pages to be rendered.**

* **`src`**/**`glob`**: `src` can be used to specify a file e.g., `docs/index.md`.<br>
 Alternatively, `glob` can be used to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)) e.g., `**/*.md`.
* **`src/glob`**
 * `src` can be used to specify a single file, or an array of files.<br>
 {{ icon_examples }} `docs/index.md` or `[ 'docs/index.md', 'docs/userGuide.md' ]` { .my-1 }
 * `glob` can be used alternatively to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)), or an array of such file patterns.<br>
 {{ icon_examples }} `**/*.md` or `[ '**/*.md', '**/*.mbdf' ]` { .my-2 }
* **`title`**: The page `<title>` for the generated web page. Titles specified here take priority over titles specified in the [front matter](addingPages.html#front-matter) of individual pages.
* **`layout`**: The [layout](tweakingThePageStructure.html#page-layouts) to be used by the page. Default: `default`.
* **`searchable`**: Specifies that the page(s) should be excluded from searching. Default: `yes`.
Expand Down

45 changes: 24 additions & 21 deletions
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ const injectMarkdownItSpecialTags = require(

const _ = {};
_.difference = require('lodash/difference');
_.flatMap = require('lodash/flatMap');
_.get = require('lodash/get');
_.has = require('lodash/has');
_.includes = require('lodash/includes');
Expand DownExpand Up@@ -442,36 +443,38 @@ class Site {
 */
 collectAddressablePages() {
 const { pages } = this.siteConfig;
 const addressableGlobs = pages.filter(page => page.glob);
 this.addressablePages = pages.filter(page => page.src);
 const pagesFromSrc = _.flatMap(pages.filter(page => page.src), page => (Array.isArray(page.src)
 ? page.src.map(pageSrc => ({ ...page, src: pageSrc }))
 : [page]));
@ang-zeyuang-zeyuMar 28, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks for the feedback and reviews! @yash-chowdhary@damithc@marvinchin
Yeah, this looks good to me 🚀 Supporting an array of src sounds great as well! Let's do it in another PR?
My bad, pushed this before seeing this message. Its just a three line change here ^ though, let me know if it should be in a separate PR!
@yash-chowdharyyash-chowdharyMar 28, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Its just a three line change here ^ though, let me know if it should be in a separate PR!
I think it can be left in this PR. 👍
 const set = new Set();
 const duplicatePages = this.addressablePages
 const duplicatePages = pagesFromSrc
 .filter(page => set.size === set.add(page.src).size)
 .map(page => page.src);
 if (duplicatePages.length > 0) {
 return Promise.reject(
 new Error(`Duplicate page entries found in site config: ${_.uniq(duplicatePages).join(', ')}`));
 }
 const globPaths = addressableGlobs.reduce((globPages, addressableGlob) =>
 globPages.concat(walkSync(this.rootPath, {
 directories: false,
 globs: [addressableGlob.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(globPath => ({
 src: globPath,
 searchable: addressableGlob.searchable,
 layout: addressableGlob.layout,
 frontmatter: addressableGlob.frontmatter,
 }))), []);
 // Add pages collected by walkSync and merge properties for pages
 const pagesFromGlobs = _.flatMap(pages.filter(page => page.glob), page => walkSync(this.rootPath, {
 directories: false,
 globs: Array.isArray(page.glob) ? page.glob : [page.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(filePath => ({
 src: filePath,
 searchable: page.searchable,
 layout: page.layout,
 frontmatter: page.frontmatter,
 })));
 /*
 Add pages collected from globs and merge properties for pages
 Page properties collected from src have priority over page properties from globs,
 while page properties from later entries take priority over earlier ones.
 */
 const filteredPages = {};
globPaths.concat(this.addressablePages).forEach((page) => {
pagesFromGlobs.concat(pagesFromSrc).forEach((page) => {
 const filteredPage = _.omitBy(page, _.isUndefined);
 if (page.src in filteredPages) {
 filteredPages[page.src] = { ...filteredPages[page.src], ...filteredPage };
 } else {
 filteredPages[page.src] = filteredPage;
 }
 filteredPages[page.src] = page.src in filteredPages
 ? { ...filteredPages[page.src], ...filteredPage }
 : filteredPage;
 });
 this.addressablePages = Object.values(filteredPages);

Expand Down

5 changes: 1 addition & 4 deletions
src/template/default/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,7 @@
 "title": "Landing Page"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
Expand Down

8 changes: 2 additions & 6 deletions
src/template/minimal/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,14 +18,10 @@
 "title": "Hello World"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
 "message": "Site Update."
 }
 }

}

12 changes: 6 additions & 6 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,19 +152,19 @@
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "layout": "default",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayouts.md",
 "layout": "default",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand All@@ -174,7 +174,7 @@
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "src": "testLayouts.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand Down

12 changes: 2 additions & 10 deletions
test/functional/test_site/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@
 "layout": "testAfterSetup"
 },
 {
 "src": "testEmptyFrontmatter.md",
 "src": ["testEmptyFrontmatter.md", "testLayoutsOverride.md"],
 "title": "Hello World",
 "layout": "testLayout"
 },
Expand All@@ -34,15 +34,7 @@
 "title": "Hello World"
 },
 {
 "src": "testLayoutsOverride.md",
 "title": "Hello World",
 "layout": "testLayout"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/test_md_fragment.md"
 "glob": ["**/index.md", "**/test_md_fragment.md"]
 },
 {
 "src": "testAntiFOUCStyles.md",
Expand Down

14 changes: 7 additions & 7 deletions
test/functional/test_site_convert/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "Home.md",
 "title": "",
Expand DownExpand Up@@ -84,6 +77,13 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 }
 ]
}

34 changes: 17 additions & 17 deletions
test/functional/test_site_templates/test_default/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "siteNav": "site-nav.md",
Expand DownExpand Up@@ -55,6 +38,23 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 }
 ]
}

, '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('^' + ".*" + '
Allow an array of globs for the globs option by ang-zeyu · Pull Request #1118 · MarkBind/markbind · GitHub
Skip to content
Allow an array of globs for the globs option#1118

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

marvinchin
merged 1 commit into

from

Mar 28, 2020
 Merged


Allow an array of globs for the globs option
#1118
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 1 addition & 7 deletions
docs/dg-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,17 +3,11 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 },
 {
 "glob": "*.md"
 "glob": ["**/*.mbd", "*.md", "devGuide/*.md"]
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "headingIndexingLevel": 6,
Expand Down

30 changes: 7 additions & 23 deletions
docs/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,32 +4,16 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md", "devGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "plugins" : [
Expand Down

27 changes: 7 additions & 20 deletions
docs/ug-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,28 +3,15 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 }
 ],
Expand Down

7 changes: 5 additions & 2 deletions
docs/userGuide/siteConfiguration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,8 +98,11 @@ _(Optional)_ **The theme for the generated site.** Uses the default Bootstrap th

**An array of pages to be rendered.**

* **`src`**/**`glob`**: `src` can be used to specify a file e.g., `docs/index.md`.<br>
 Alternatively, `glob` can be used to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)) e.g., `**/*.md`.
* **`src/glob`**
 * `src` can be used to specify a single file, or an array of files.<br>
 {{ icon_examples }} `docs/index.md` or `[ 'docs/index.md', 'docs/userGuide.md' ]` { .my-1 }
 * `glob` can be used alternatively to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)), or an array of such file patterns.<br>
 {{ icon_examples }} `**/*.md` or `[ '**/*.md', '**/*.mbdf' ]` { .my-2 }
* **`title`**: The page `<title>` for the generated web page. Titles specified here take priority over titles specified in the [front matter](addingPages.html#front-matter) of individual pages.
* **`layout`**: The [layout](tweakingThePageStructure.html#page-layouts) to be used by the page. Default: `default`.
* **`searchable`**: Specifies that the page(s) should be excluded from searching. Default: `yes`.
Expand Down

45 changes: 24 additions & 21 deletions
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ const injectMarkdownItSpecialTags = require(

const _ = {};
_.difference = require('lodash/difference');
_.flatMap = require('lodash/flatMap');
_.get = require('lodash/get');
_.has = require('lodash/has');
_.includes = require('lodash/includes');
Expand DownExpand Up@@ -442,36 +443,38 @@ class Site {
 */
 collectAddressablePages() {
 const { pages } = this.siteConfig;
 const addressableGlobs = pages.filter(page => page.glob);
 this.addressablePages = pages.filter(page => page.src);
 const pagesFromSrc = _.flatMap(pages.filter(page => page.src), page => (Array.isArray(page.src)
 ? page.src.map(pageSrc => ({ ...page, src: pageSrc }))
 : [page]));
@ang-zeyuang-zeyuMar 28, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks for the feedback and reviews! @yash-chowdhary@damithc@marvinchin
Yeah, this looks good to me 🚀 Supporting an array of src sounds great as well! Let's do it in another PR?
My bad, pushed this before seeing this message. Its just a three line change here ^ though, let me know if it should be in a separate PR!
@yash-chowdharyyash-chowdharyMar 28, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Its just a three line change here ^ though, let me know if it should be in a separate PR!
I think it can be left in this PR. 👍
 const set = new Set();
 const duplicatePages = this.addressablePages
 const duplicatePages = pagesFromSrc
 .filter(page => set.size === set.add(page.src).size)
 .map(page => page.src);
 if (duplicatePages.length > 0) {
 return Promise.reject(
 new Error(`Duplicate page entries found in site config: ${_.uniq(duplicatePages).join(', ')}`));
 }
 const globPaths = addressableGlobs.reduce((globPages, addressableGlob) =>
 globPages.concat(walkSync(this.rootPath, {
 directories: false,
 globs: [addressableGlob.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(globPath => ({
 src: globPath,
 searchable: addressableGlob.searchable,
 layout: addressableGlob.layout,
 frontmatter: addressableGlob.frontmatter,
 }))), []);
 // Add pages collected by walkSync and merge properties for pages
 const pagesFromGlobs = _.flatMap(pages.filter(page => page.glob), page => walkSync(this.rootPath, {
 directories: false,
 globs: Array.isArray(page.glob) ? page.glob : [page.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(filePath => ({
 src: filePath,
 searchable: page.searchable,
 layout: page.layout,
 frontmatter: page.frontmatter,
 })));
 /*
 Add pages collected from globs and merge properties for pages
 Page properties collected from src have priority over page properties from globs,
 while page properties from later entries take priority over earlier ones.
 */
 const filteredPages = {};
globPaths.concat(this.addressablePages).forEach((page) => {
pagesFromGlobs.concat(pagesFromSrc).forEach((page) => {
 const filteredPage = _.omitBy(page, _.isUndefined);
 if (page.src in filteredPages) {
 filteredPages[page.src] = { ...filteredPages[page.src], ...filteredPage };
 } else {
 filteredPages[page.src] = filteredPage;
 }
 filteredPages[page.src] = page.src in filteredPages
 ? { ...filteredPages[page.src], ...filteredPage }
 : filteredPage;
 });
 this.addressablePages = Object.values(filteredPages);

Expand Down

5 changes: 1 addition & 4 deletions
src/template/default/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,7 @@
 "title": "Landing Page"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
Expand Down

8 changes: 2 additions & 6 deletions
src/template/minimal/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,14 +18,10 @@
 "title": "Hello World"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
 "message": "Site Update."
 }
 }

}

12 changes: 6 additions & 6 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,19 +152,19 @@
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "layout": "default",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayouts.md",
 "layout": "default",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand All@@ -174,7 +174,7 @@
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "src": "testLayouts.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand Down

12 changes: 2 additions & 10 deletions
test/functional/test_site/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@
 "layout": "testAfterSetup"
 },
 {
 "src": "testEmptyFrontmatter.md",
 "src": ["testEmptyFrontmatter.md", "testLayoutsOverride.md"],
 "title": "Hello World",
 "layout": "testLayout"
 },
Expand All@@ -34,15 +34,7 @@
 "title": "Hello World"
 },
 {
 "src": "testLayoutsOverride.md",
 "title": "Hello World",
 "layout": "testLayout"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/test_md_fragment.md"
 "glob": ["**/index.md", "**/test_md_fragment.md"]
 },
 {
 "src": "testAntiFOUCStyles.md",
Expand Down

14 changes: 7 additions & 7 deletions
test/functional/test_site_convert/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "Home.md",
 "title": "",
Expand DownExpand Up@@ -84,6 +77,13 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 }
 ]
}

34 changes: 17 additions & 17 deletions
test/functional/test_site_templates/test_default/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "siteNav": "site-nav.md",
Expand DownExpand Up@@ -55,6 +38,23 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 }
 ]
}

, '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); }
})();
})();
Allow an array of globs for the globs option by ang-zeyu · Pull Request #1118 · MarkBind/markbind · GitHub
Skip to content
Allow an array of globs for the globs option#1118

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

marvinchin
merged 1 commit into

from

Mar 28, 2020
 Merged


Allow an array of globs for the globs option
#1118
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 1 addition & 7 deletions
docs/dg-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,17 +3,11 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 },
 {
 "glob": "*.md"
 "glob": ["**/*.mbd", "*.md", "devGuide/*.md"]
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "headingIndexingLevel": 6,
Expand Down

30 changes: 7 additions & 23 deletions
docs/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,32 +4,16 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md", "devGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "searchable": "no"
 },
 {
 "glob": "devGuide/*.md"
 }
 ],
 "plugins" : [
Expand Down

27 changes: 7 additions & 20 deletions
docs/ug-site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,28 +3,15 @@
 "titlePrefix": "MarkBind",
 "pages": [
 {
 "glob": "**/*.mbd"
 "glob": ["**/*.mbd", "*.md", "userGuide/*.md"]
 },
 {
 "glob": "*.md"
 },
 {
 "src": "index.md",
 "searchable": "no"
 },
 {
 "glob": "userGuide/*.md"
 },
 {
 "src": "userGuide/fullSyntaxReference.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/syntaxCheatSheet.md",
 "searchable": "no"
 },
 {
 "src": "userGuide/readerFacingFeatures.md",
 "src": [
 "index.md",
 "userGuide/fullSyntaxReference.md",
 "userGuide/syntaxCheatSheet.md",
 "userGuide/readerFacingFeatures.md"
 ],
 "searchable": "no"
 }
 ],
Expand Down

7 changes: 5 additions & 2 deletions
docs/userGuide/siteConfiguration.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,8 +98,11 @@ _(Optional)_ **The theme for the generated site.** Uses the default Bootstrap th

**An array of pages to be rendered.**

* **`src`**/**`glob`**: `src` can be used to specify a file e.g., `docs/index.md`.<br>
 Alternatively, `glob` can be used to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)) e.g., `**/*.md`.
* **`src/glob`**
 * `src` can be used to specify a single file, or an array of files.<br>
 {{ icon_examples }} `docs/index.md` or `[ 'docs/index.md', 'docs/userGuide.md' ]` { .my-1 }
 * `glob` can be used alternatively to define a file pattern in the [_glob syntax_](https://en.wikipedia.org/wiki/Glob_(programming)), or an array of such file patterns.<br>
 {{ icon_examples }} `**/*.md` or `[ '**/*.md', '**/*.mbdf' ]` { .my-2 }
* **`title`**: The page `<title>` for the generated web page. Titles specified here take priority over titles specified in the [front matter](addingPages.html#front-matter) of individual pages.
* **`layout`**: The [layout](tweakingThePageStructure.html#page-layouts) to be used by the page. Default: `default`.
* **`searchable`**: Specifies that the page(s) should be excluded from searching. Default: `yes`.
Expand Down

45 changes: 24 additions & 21 deletions
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ const injectMarkdownItSpecialTags = require(

const _ = {};
_.difference = require('lodash/difference');
_.flatMap = require('lodash/flatMap');
_.get = require('lodash/get');
_.has = require('lodash/has');
_.includes = require('lodash/includes');
Expand DownExpand Up@@ -442,36 +443,38 @@ class Site {
 */
 collectAddressablePages() {
 const { pages } = this.siteConfig;
 const addressableGlobs = pages.filter(page => page.glob);
 this.addressablePages = pages.filter(page => page.src);
 const pagesFromSrc = _.flatMap(pages.filter(page => page.src), page => (Array.isArray(page.src)
 ? page.src.map(pageSrc => ({ ...page, src: pageSrc }))
 : [page]));
@ang-zeyuang-zeyuMar 28, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Thanks for the feedback and reviews! @yash-chowdhary@damithc@marvinchin
Yeah, this looks good to me 🚀 Supporting an array of src sounds great as well! Let's do it in another PR?
My bad, pushed this before seeing this message. Its just a three line change here ^ though, let me know if it should be in a separate PR!
@yash-chowdharyyash-chowdharyMar 28, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Its just a three line change here ^ though, let me know if it should be in a separate PR!
I think it can be left in this PR. 👍
 const set = new Set();
 const duplicatePages = this.addressablePages
 const duplicatePages = pagesFromSrc
 .filter(page => set.size === set.add(page.src).size)
 .map(page => page.src);
 if (duplicatePages.length > 0) {
 return Promise.reject(
 new Error(`Duplicate page entries found in site config: ${_.uniq(duplicatePages).join(', ')}`));
 }
 const globPaths = addressableGlobs.reduce((globPages, addressableGlob) =>
 globPages.concat(walkSync(this.rootPath, {
 directories: false,
 globs: [addressableGlob.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(globPath => ({
 src: globPath,
 searchable: addressableGlob.searchable,
 layout: addressableGlob.layout,
 frontmatter: addressableGlob.frontmatter,
 }))), []);
 // Add pages collected by walkSync and merge properties for pages
 const pagesFromGlobs = _.flatMap(pages.filter(page => page.glob), page => walkSync(this.rootPath, {
 directories: false,
 globs: Array.isArray(page.glob) ? page.glob : [page.glob],
 ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME],
 }).map(filePath => ({
 src: filePath,
 searchable: page.searchable,
 layout: page.layout,
 frontmatter: page.frontmatter,
 })));
 /*
 Add pages collected from globs and merge properties for pages
 Page properties collected from src have priority over page properties from globs,
 while page properties from later entries take priority over earlier ones.
 */
 const filteredPages = {};
globPaths.concat(this.addressablePages).forEach((page) => {
pagesFromGlobs.concat(pagesFromSrc).forEach((page) => {
 const filteredPage = _.omitBy(page, _.isUndefined);
 if (page.src in filteredPages) {
 filteredPages[page.src] = { ...filteredPages[page.src], ...filteredPage };
 } else {
 filteredPages[page.src] = filteredPage;
 }
 filteredPages[page.src] = page.src in filteredPages
 ? { ...filteredPages[page.src], ...filteredPage }
 : filteredPage;
 });
 this.addressablePages = Object.values(filteredPages);

Expand Down

5 changes: 1 addition & 4 deletions
src/template/default/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,7 @@
 "title": "Landing Page"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
Expand Down

8 changes: 2 additions & 6 deletions
src/template/minimal/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,14 +18,10 @@
 "title": "Hello World"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/*.+(md|mbd)"
 "glob": ["**/index.md", "**/*.+(md|mbd)"]
 }
 ],
 "deploy": {
 "message": "Site Update."
 }
 }

}

12 changes: 6 additions & 6 deletions
test/functional/test_site/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -152,19 +152,19 @@
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "layout": "default",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "testExternalScripts.md",
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayouts.md",
 "layout": "default",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand All@@ -174,7 +174,7 @@
 "title": "Hello World",
 "head": "overwriteLayoutHead.md",
 "layout": "testLayout",
 "src": "testLayoutsOverride.md",
 "src": "testLayouts.md",
 "globalOverrideProperty": "Overridden by global override",
 "globalAndFrontMatterOverrideProperty": "Overridden by global override",
 "headings": {},
Expand Down

12 changes: 2 additions & 10 deletions
test/functional/test_site/site.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@
 "layout": "testAfterSetup"
 },
 {
 "src": "testEmptyFrontmatter.md",
 "src": ["testEmptyFrontmatter.md", "testLayoutsOverride.md"],
 "title": "Hello World",
 "layout": "testLayout"
 },
Expand All@@ -34,15 +34,7 @@
 "title": "Hello World"
 },
 {
 "src": "testLayoutsOverride.md",
 "title": "Hello World",
 "layout": "testLayout"
 },
 {
 "glob": "**/index.md"
 },
 {
 "glob": "**/test_md_fragment.md"
 "glob": ["**/index.md", "**/test_md_fragment.md"]
 },
 {
 "src": "testAntiFOUCStyles.md",
Expand Down

14 changes: 7 additions & 7 deletions
test/functional/test_site_convert/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "Home.md",
 "title": "",
Expand DownExpand Up@@ -84,6 +77,13 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 }
 ]
}

34 changes: 17 additions & 17 deletions
test/functional/test_site_templates/test_default/expected/siteData.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,6 @@
{
 "enableSearch": true,
 "pages": [
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "siteNav": "site-nav.md",
Expand DownExpand Up@@ -55,6 +38,23 @@
 "layout": "default",
 "headings": {},
 "headingKeywords": {}
 },
 {
 "header": "header.md",
 "pageNav": 2,
 "pageNavTitle": "Chapters of This Page",
 "siteNav": "site-nav.md",
 "src": "index.md",
 "title": "Landing Page",
 "layout": "default",
 "headings": {
 "heading-1": "Heading 1",
 "sub-heading-1-1": "Sub Heading 1.1",
 "sub-heading-1-2": "Sub Heading 1.2",
 "heading-2": "Heading 2",
 "heading-3": "Heading 3"
 },
 "headingKeywords": {}
 }
 ]
}