Allow live reloading for plugin defined sources#955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yamgent merged 1 commit into from
Dec 23, 2019
Merged

Allow live reloading for plugin defined sources #955

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
28 changes: 28 additions & 0 deletions docs/userGuide/usingPlugins.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -143,6 +143,34 @@ This will add the following link and script elements to the page:
- `<script src="SCRIPT_LINK"></script>`
- `<script>alert("hello")</script>`

#### Live reload

By default, MarkBind treats `.html`, `.md`, `.mbd`, and `.mbdf` as source files, and will rebuild any
pages changed when serving the page.

During the `preRender` and `postRender` stages however, plugins may do custom processing using some other
source file types, as parsed from the raw Markdown, typically requiring rebuilding the site.

Hence, to add custom source files to watch, you can implement the `getSources()` method.
- `getSources(content, pluginContext, frontMatter)`: Returns an array of source file paths to watch. Called **before** a Markdown file's `preRender` function is called.
- `content`: The raw Markdown of the current Markdown file (`.md`, `.mbd`, etc.).
- `pluginContext`: User provided parameters for the plugin. This can be specified in the `site.json`.
- `frontMatter`: The frontMatter of the page being processed, in case any frontMatter data is required.

Example usage of `getSources` from the PlantUML plugin:

```js
{
...
getSources: (content) => {
// Add all src attributes in <puml> tags to watch list
const $ = cheerio.load(content, { xmlMode: true });

return $('puml').map((i, tag) => tag.attribs.src).get();
},
}
```

### Advanced: Default plugins

MarkBind has a set of default plugins that it uses to carry out some of its features. These are enabled by default for every project and should be left alone.
Expand Down
6 changes: 3 additions & 3 deletions index.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ program
const addHandler = (filePath) => {
logger.info(`[${new Date().toLocaleTimeString()}] Reload for file add: ${filePath}`);
Promise.resolve('').then(() => {
if (fsUtil.isSourceFile(filePath)) {
if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
return site.rebuildSourceFiles(filePath);
}
return site.buildAsset(filePath);
Expand All@@ -131,7 +131,7 @@ program
const changeHandler = (filePath) => {
logger.info(`[${new Date().toLocaleTimeString()}] Reload for file change: ${filePath}`);
Promise.resolve('').then(() => {
if (fsUtil.isSourceFile(filePath)) {
if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
return site.rebuildAffectedSourceFiles(filePath);
}
return site.buildAsset(filePath);
Expand All@@ -143,7 +143,7 @@ program
const removeHandler = (filePath) => {
logger.info(`[${new Date().toLocaleTimeString()}] Reload for file deletion: ${filePath}`);
Promise.resolve('').then(() => {
if (fsUtil.isSourceFile(filePath)) {
if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
return site.rebuildSourceFiles(filePath);
}
return site.removeAsset(filePath);
Expand Down
17 changes: 17 additions & 0 deletions src/Page.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ function Page(pageConfig) {
this.headings = {};
this.headingIndexingLevel = pageConfig.headingIndexingLevel;
this.includedFiles = new Set();
this.pluginSourceFiles = new Set();
this.keywords = {};
this.navigableHeadings = {};
this.pageSectionsHtml = {};
Expand DownExpand Up@@ -794,6 +795,7 @@ Page.prototype.generate = function (builtFiles) {
})
.then(result => removePageHeaderAndFooter(result))
.then(result => addContentWrapper(result))
.then(result => this.collectPluginSources(result))
.then(result => this.preRender(result))
.then(result => this.insertSiteNav((result)))
.then(result => this.insertHeaderFile(result))
Expand DownExpand Up@@ -861,6 +863,21 @@ Page.prototype.getPluginConfig = function () {
};
};

/**
* Collects file sources provided by plugins for the page
*/
Page.prototype.collectPluginSources = function (content) {
Object.entries(this.plugins).forEach(([pluginName, plugin]) => {
if (plugin.getSources) {
const sources = plugin.getSources(content, this.pluginsContext[pluginName] || {},
this.frontMatter, this.getPluginConfig());
sources.forEach(src => this.pluginSourceFiles.add(path.resolve(ensurePosix(src))));
}
});

return content;
};

/**
* Entry point for plugin pre-render
*/
Expand Down
16 changes: 15 additions & 1 deletion src/Site.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -699,6 +699,15 @@ function findDefaultPlugins() {
}).map(file => path.parse(file).name);
}

/**
* Checks if a specified file path is a plugin source file
* @param filePath file path to check
* @returns {boolean} whether the file path matches a plugin source file path
*/
Site.prototype.isPluginSourceFile = function (filePath) {
return this.pages.some(page => page.pluginSourceFiles.has(filePath));
};

/**
* Loads a plugin
* @param plugin name of the plugin
Expand DownExpand Up@@ -827,7 +836,12 @@ Site.prototype.regenerateAffectedPages = function (filePaths) {
}
this._setTimestampVariable();
this.pages.forEach((page) => {
if (shouldRebuildAllPages || filePaths.some(filePath => page.includedFiles.has(filePath))) {
if (shouldRebuildAllPages || filePaths.some((filePath) => {
const isIncludedFile = page.includedFiles.has(filePath);
const isPluginSourceFile = page.pluginSourceFiles.has(filePath);

return isIncludedFile || isPluginSourceFile;
})) {
// eslint-disable-next-line no-param-reassign
page.userDefinedVariablesMap = this.userDefinedVariablesMap;
processingFiles.push(page.generate(builtFiles)
Expand Down
2 changes: 1 addition & 1 deletion src/constants.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,5 +73,5 @@ module.exports = {
requiredFiles: ['index.md', 'site.json', '_markbind/'],

// src/util/fsUtil.js
sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf', '.puml'],
sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf'],
};
17 changes: 11 additions & 6 deletions src/plugins/default/markbind-plugin-plantuml.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,12 +85,9 @@ function generateDiagram(src, cwf, config) {
errorLog += errorMsg;
});

childProcess.on('close', (code) => {
if (code !== 0) {
logger.error(`${ERR_PROCESSING} ${rawDiagramPath}`);
// This goes to the log file, but not shown on the console
logger.debug(errorLog);
}
childProcess.on('exit', () => {
// This goes to the log file, but not shown on the console
logger.debug(errorLog);
});
});

Expand All@@ -99,6 +96,8 @@ function generateDiagram(src, cwf, config) {

module.exports = {
preRender: (content, pluginContext, frontmatter, config) => {
// Clear <puml> tags processed before for live reload
processedDiagrams.clear();
// Processes all <puml> tags
const $ = cheerio.load(content, { xmlMode: true });
$('puml').each((i, tag) => {
Expand All@@ -111,4 +110,10 @@ module.exports = {

return $.html();
},
getSources: (content) => {
// Add all src attributes in <puml> tags to watch list
const $ = cheerio.load(content, { xmlMode: true });

return $('puml').map((i, tag) => tag.attribs.src).get();
},
};
28 changes: 28 additions & 0 deletions test/functional/test_site/expected/index.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -465,6 +465,34 @@ <h1 id="markbind-plugin-pre-render">Markbind Plugin Pre-render<a class="fa fa-an
<p>Node Modules Plugin Post-render</p>
</div>
<p><strong>Test search indexing</strong></p>
<p><strong>Test PlantUML live reload without include</strong>
<pic src="/test_site/diagrams/activity.png" alt="activity diagram"></pic>
</p>
<p><strong>Test PlantUML live reload with include</strong></p>
<div>
<p><strong>PlantUML Test</strong></p>
<p><strong>Sequence Diagram</strong>
<pic src="/test_site/diagrams/sequence.png"></pic>
</p>
<p><strong>Use Case Diagram</strong>
<pic src="/test_site/diagrams/usecase.png"></pic>
</p>
<p><strong>Class Diagram</strong>
<pic src="/test_site/diagrams/class.png"></pic>
</p>
<p><strong>Activity Diagram</strong>
<pic src="/test_site/diagrams/activity.png"></pic>
</p>
<p><strong>Component Diagram</strong>
<pic src="/test_site/diagrams/component.png"></pic>
</p>
<p><strong>State Diagram</strong>
<pic src="/test_site/diagrams/state.png"></pic>
</p>
<p><strong>Object Diagram</strong>
<pic src="/test_site/diagrams/object.png"></pic>
</p>
</div>
<h2 class="no-index" id="level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed">Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed<a class="fa fa-anchor" href="#level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed"></a></h2>
<h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed">Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed<a class="fa fa-anchor" href="#level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed"></a></h6>
<hr class="footnotes-sep">
Expand Down
8 changes: 7 additions & 1 deletion test/functional/test_site/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -276,6 +276,12 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd

**Test search indexing**

**Test PlantUML live reload without include**
<puml src="diagrams/activity.puml" alt="activity diagram" />

**Test PlantUML live reload with include**
<include src="testPlantUML.md" />

## Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed {.no-index}

###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}
###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Allow live reloading for plugin defined sources#955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

Dec 23, 2019
 Merged


Allow live reloading for plugin defined sources
#955
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


28 changes: 28 additions & 0 deletions
docs/userGuide/usingPlugins.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -143,6 +143,34 @@ This will add the following link and script elements to the page:
- `<script src="SCRIPT_LINK"></script>`
- `<script>alert("hello")</script>`

#### Live reload

By default, MarkBind treats `.html`, `.md`, `.mbd`, and `.mbdf` as source files, and will rebuild any
pages changed when serving the page.

During the `preRender` and `postRender` stages however, plugins may do custom processing using some other
source file types, as parsed from the raw Markdown, typically requiring rebuilding the site.

Hence, to add custom source files to watch, you can implement the `getSources()` method.
- `getSources(content, pluginContext, frontMatter)`: Returns an array of source file paths to watch. Called **before** a Markdown file's `preRender` function is called.
 - `content`: The raw Markdown of the current Markdown file (`.md`, `.mbd`, etc.).
 - `pluginContext`: User provided parameters for the plugin. This can be specified in the `site.json`.
 - `frontMatter`: The frontMatter of the page being processed, in case any frontMatter data is required.

Example usage of `getSources` from the PlantUML plugin:

```js
{
 ...
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
}
```

### Advanced: Default plugins

MarkBind has a set of default plugins that it uses to carry out some of its features. These are enabled by default for every project and should be left alone.
Expand Down

6 changes: 3 additions & 3 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ program
 const addHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file add: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -131,7 +131,7 @@ program
 const changeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file change: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildAffectedSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -143,7 +143,7 @@ program
 const removeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file deletion: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.removeAsset(filePath);
Expand Down

17 changes: 17 additions & 0 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ function Page(pageConfig) {
 this.headings = {};
 this.headingIndexingLevel = pageConfig.headingIndexingLevel;
 this.includedFiles = new Set();
 this.pluginSourceFiles = new Set();
 this.keywords = {};
 this.navigableHeadings = {};
 this.pageSectionsHtml = {};
Expand DownExpand Up@@ -794,6 +795,7 @@ Page.prototype.generate = function (builtFiles) {
 })
 .then(result => removePageHeaderAndFooter(result))
 .then(result => addContentWrapper(result))
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
Expand DownExpand Up@@ -861,6 +863,21 @@ Page.prototype.getPluginConfig = function () {
 };
};

/**
 * Collects file sources provided by plugins for the page
 */
Page.prototype.collectPluginSources = function (content) {
 Object.entries(this.plugins).forEach(([pluginName, plugin]) => {
 if (plugin.getSources) {
 const sources = plugin.getSources(content, this.pluginsContext[pluginName] || {},
 this.frontMatter, this.getPluginConfig());
 sources.forEach(src => this.pluginSourceFiles.add(path.resolve(ensurePosix(src))));
 }
 });

 return content;
};

/**
 * Entry point for plugin pre-render
 */
Expand Down

16 changes: 15 additions & 1 deletion
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -699,6 +699,15 @@ function findDefaultPlugins() {
 }).map(file => path.parse(file).name);
}

/**
 * Checks if a specified file path is a plugin source file
 * @param filePath file path to check
 * @returns {boolean} whether the file path matches a plugin source file path
 */
Site.prototype.isPluginSourceFile = function (filePath) {
 return this.pages.some(page => page.pluginSourceFiles.has(filePath));
};

/**
 * Loads a plugin
 * @param plugin name of the plugin
Expand DownExpand Up@@ -827,7 +836,12 @@ Site.prototype.regenerateAffectedPages = function (filePaths) {
 }
 this._setTimestampVariable();
 this.pages.forEach((page) => {
 if (shouldRebuildAllPages || filePaths.some(filePath => page.includedFiles.has(filePath))) {
 if (shouldRebuildAllPages || filePaths.some((filePath) => {
 const isIncludedFile = page.includedFiles.has(filePath);
 const isPluginSourceFile = page.pluginSourceFiles.has(filePath);

 return isIncludedFile || isPluginSourceFile;
 })) {
 // eslint-disable-next-line no-param-reassign
 page.userDefinedVariablesMap = this.userDefinedVariablesMap;
 processingFiles.push(page.generate(builtFiles)
Expand Down

2 changes: 1 addition & 1 deletion
src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,5 +73,5 @@ module.exports = {
 requiredFiles: ['index.md', 'site.json', '_markbind/'],

 // src/util/fsUtil.js
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf', '.puml'],
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf'],
};

17 changes: 11 additions & 6 deletions
src/plugins/default/markbind-plugin-plantuml.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,12 +85,9 @@ function generateDiagram(src, cwf, config) {
 errorLog += errorMsg;
 });

 childProcess.on('close', (code) => {
 if (code !== 0) {
 logger.error(`${ERR_PROCESSING} ${rawDiagramPath}`);
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 }
 childProcess.on('exit', () => {
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 });
 });

Expand All@@ -99,6 +96,8 @@ function generateDiagram(src, cwf, config) {

module.exports = {
 preRender: (content, pluginContext, frontmatter, config) => {
 // Clear <puml> tags processed before for live reload
 processedDiagrams.clear();
 // Processes all <puml> tags
 const $ = cheerio.load(content, { xmlMode: true });
 $('puml').each((i, tag) => {
Expand All@@ -111,4 +110,10 @@ module.exports = {

 return $.html();
 },
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
};

28 changes: 28 additions & 0 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -465,6 +465,34 @@ <h1 id="markbind-plugin-pre-render">Markbind Plugin Pre-render<a class="fa fa-an
 <p>Node Modules Plugin Post-render</p>
 </div>
 <p><strong>Test search indexing</strong></p>
 <p><strong>Test PlantUML live reload without include</strong>
 <pic src="/test_site/diagrams/activity.png" alt="activity diagram"></pic>
 </p>
 <p><strong>Test PlantUML live reload with include</strong></p>
 <div>
 <p><strong>PlantUML Test</strong></p>
 <p><strong>Sequence Diagram</strong>
 <pic src="/test_site/diagrams/sequence.png"></pic>
 </p>
 <p><strong>Use Case Diagram</strong>
 <pic src="/test_site/diagrams/usecase.png"></pic>
 </p>
 <p><strong>Class Diagram</strong>
 <pic src="/test_site/diagrams/class.png"></pic>
 </p>
 <p><strong>Activity Diagram</strong>
 <pic src="/test_site/diagrams/activity.png"></pic>
 </p>
 <p><strong>Component Diagram</strong>
 <pic src="/test_site/diagrams/component.png"></pic>
 </p>
 <p><strong>State Diagram</strong>
 <pic src="/test_site/diagrams/state.png"></pic>
 </p>
 <p><strong>Object Diagram</strong>
 <pic src="/test_site/diagrams/object.png"></pic>
 </p>
 </div>
 <h2 class="no-index" id="level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed">Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed<a class="fa fa-anchor" href="#level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed"></a></h2>
 <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed">Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed<a class="fa fa-anchor" href="#level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed"></a></h6>
 <hr class="footnotes-sep">
Expand Down

8 changes: 7 additions & 1 deletion
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -276,6 +276,12 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd

**Test search indexing**

**Test PlantUML live reload without include**
<puml src="diagrams/activity.puml" alt="activity diagram" />

**Test PlantUML live reload with include**
<include src="testPlantUML.md" />

## Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed {.no-index}

###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}
###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}

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

Skip to content
Allow live reloading for plugin defined sources#955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

Dec 23, 2019
 Merged


Allow live reloading for plugin defined sources
#955
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


28 changes: 28 additions & 0 deletions
docs/userGuide/usingPlugins.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -143,6 +143,34 @@ This will add the following link and script elements to the page:
- `<script src="SCRIPT_LINK"></script>`
- `<script>alert("hello")</script>`

#### Live reload

By default, MarkBind treats `.html`, `.md`, `.mbd`, and `.mbdf` as source files, and will rebuild any
pages changed when serving the page.

During the `preRender` and `postRender` stages however, plugins may do custom processing using some other
source file types, as parsed from the raw Markdown, typically requiring rebuilding the site.

Hence, to add custom source files to watch, you can implement the `getSources()` method.
- `getSources(content, pluginContext, frontMatter)`: Returns an array of source file paths to watch. Called **before** a Markdown file's `preRender` function is called.
 - `content`: The raw Markdown of the current Markdown file (`.md`, `.mbd`, etc.).
 - `pluginContext`: User provided parameters for the plugin. This can be specified in the `site.json`.
 - `frontMatter`: The frontMatter of the page being processed, in case any frontMatter data is required.

Example usage of `getSources` from the PlantUML plugin:

```js
{
 ...
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
}
```

### Advanced: Default plugins

MarkBind has a set of default plugins that it uses to carry out some of its features. These are enabled by default for every project and should be left alone.
Expand Down

6 changes: 3 additions & 3 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ program
 const addHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file add: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -131,7 +131,7 @@ program
 const changeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file change: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildAffectedSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -143,7 +143,7 @@ program
 const removeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file deletion: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.removeAsset(filePath);
Expand Down

17 changes: 17 additions & 0 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ function Page(pageConfig) {
 this.headings = {};
 this.headingIndexingLevel = pageConfig.headingIndexingLevel;
 this.includedFiles = new Set();
 this.pluginSourceFiles = new Set();
 this.keywords = {};
 this.navigableHeadings = {};
 this.pageSectionsHtml = {};
Expand DownExpand Up@@ -794,6 +795,7 @@ Page.prototype.generate = function (builtFiles) {
 })
 .then(result => removePageHeaderAndFooter(result))
 .then(result => addContentWrapper(result))
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
Expand DownExpand Up@@ -861,6 +863,21 @@ Page.prototype.getPluginConfig = function () {
 };
};

/**
 * Collects file sources provided by plugins for the page
 */
Page.prototype.collectPluginSources = function (content) {
 Object.entries(this.plugins).forEach(([pluginName, plugin]) => {
 if (plugin.getSources) {
 const sources = plugin.getSources(content, this.pluginsContext[pluginName] || {},
 this.frontMatter, this.getPluginConfig());
 sources.forEach(src => this.pluginSourceFiles.add(path.resolve(ensurePosix(src))));
 }
 });

 return content;
};

/**
 * Entry point for plugin pre-render
 */
Expand Down

16 changes: 15 additions & 1 deletion
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -699,6 +699,15 @@ function findDefaultPlugins() {
 }).map(file => path.parse(file).name);
}

/**
 * Checks if a specified file path is a plugin source file
 * @param filePath file path to check
 * @returns {boolean} whether the file path matches a plugin source file path
 */
Site.prototype.isPluginSourceFile = function (filePath) {
 return this.pages.some(page => page.pluginSourceFiles.has(filePath));
};

/**
 * Loads a plugin
 * @param plugin name of the plugin
Expand DownExpand Up@@ -827,7 +836,12 @@ Site.prototype.regenerateAffectedPages = function (filePaths) {
 }
 this._setTimestampVariable();
 this.pages.forEach((page) => {
 if (shouldRebuildAllPages || filePaths.some(filePath => page.includedFiles.has(filePath))) {
 if (shouldRebuildAllPages || filePaths.some((filePath) => {
 const isIncludedFile = page.includedFiles.has(filePath);
 const isPluginSourceFile = page.pluginSourceFiles.has(filePath);

 return isIncludedFile || isPluginSourceFile;
 })) {
 // eslint-disable-next-line no-param-reassign
 page.userDefinedVariablesMap = this.userDefinedVariablesMap;
 processingFiles.push(page.generate(builtFiles)
Expand Down

2 changes: 1 addition & 1 deletion
src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,5 +73,5 @@ module.exports = {
 requiredFiles: ['index.md', 'site.json', '_markbind/'],

 // src/util/fsUtil.js
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf', '.puml'],
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf'],
};

17 changes: 11 additions & 6 deletions
src/plugins/default/markbind-plugin-plantuml.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,12 +85,9 @@ function generateDiagram(src, cwf, config) {
 errorLog += errorMsg;
 });

 childProcess.on('close', (code) => {
 if (code !== 0) {
 logger.error(`${ERR_PROCESSING} ${rawDiagramPath}`);
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 }
 childProcess.on('exit', () => {
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 });
 });

Expand All@@ -99,6 +96,8 @@ function generateDiagram(src, cwf, config) {

module.exports = {
 preRender: (content, pluginContext, frontmatter, config) => {
 // Clear <puml> tags processed before for live reload
 processedDiagrams.clear();
 // Processes all <puml> tags
 const $ = cheerio.load(content, { xmlMode: true });
 $('puml').each((i, tag) => {
Expand All@@ -111,4 +110,10 @@ module.exports = {

 return $.html();
 },
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
};

28 changes: 28 additions & 0 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -465,6 +465,34 @@ <h1 id="markbind-plugin-pre-render">Markbind Plugin Pre-render<a class="fa fa-an
 <p>Node Modules Plugin Post-render</p>
 </div>
 <p><strong>Test search indexing</strong></p>
 <p><strong>Test PlantUML live reload without include</strong>
 <pic src="/test_site/diagrams/activity.png" alt="activity diagram"></pic>
 </p>
 <p><strong>Test PlantUML live reload with include</strong></p>
 <div>
 <p><strong>PlantUML Test</strong></p>
 <p><strong>Sequence Diagram</strong>
 <pic src="/test_site/diagrams/sequence.png"></pic>
 </p>
 <p><strong>Use Case Diagram</strong>
 <pic src="/test_site/diagrams/usecase.png"></pic>
 </p>
 <p><strong>Class Diagram</strong>
 <pic src="/test_site/diagrams/class.png"></pic>
 </p>
 <p><strong>Activity Diagram</strong>
 <pic src="/test_site/diagrams/activity.png"></pic>
 </p>
 <p><strong>Component Diagram</strong>
 <pic src="/test_site/diagrams/component.png"></pic>
 </p>
 <p><strong>State Diagram</strong>
 <pic src="/test_site/diagrams/state.png"></pic>
 </p>
 <p><strong>Object Diagram</strong>
 <pic src="/test_site/diagrams/object.png"></pic>
 </p>
 </div>
 <h2 class="no-index" id="level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed">Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed<a class="fa fa-anchor" href="#level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed"></a></h2>
 <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed">Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed<a class="fa fa-anchor" href="#level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed"></a></h6>
 <hr class="footnotes-sep">
Expand Down

8 changes: 7 additions & 1 deletion
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -276,6 +276,12 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd

**Test search indexing**

**Test PlantUML live reload without include**
<puml src="diagrams/activity.puml" alt="activity diagram" />

**Test PlantUML live reload with include**
<include src="testPlantUML.md" />

## Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed {.no-index}

###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}
###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}

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

Skip to content
Allow live reloading for plugin defined sources#955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

Dec 23, 2019
 Merged


Allow live reloading for plugin defined sources
#955
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


28 changes: 28 additions & 0 deletions
docs/userGuide/usingPlugins.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -143,6 +143,34 @@ This will add the following link and script elements to the page:
- `<script src="SCRIPT_LINK"></script>`
- `<script>alert("hello")</script>`

#### Live reload

By default, MarkBind treats `.html`, `.md`, `.mbd`, and `.mbdf` as source files, and will rebuild any
pages changed when serving the page.

During the `preRender` and `postRender` stages however, plugins may do custom processing using some other
source file types, as parsed from the raw Markdown, typically requiring rebuilding the site.

Hence, to add custom source files to watch, you can implement the `getSources()` method.
- `getSources(content, pluginContext, frontMatter)`: Returns an array of source file paths to watch. Called **before** a Markdown file's `preRender` function is called.
 - `content`: The raw Markdown of the current Markdown file (`.md`, `.mbd`, etc.).
 - `pluginContext`: User provided parameters for the plugin. This can be specified in the `site.json`.
 - `frontMatter`: The frontMatter of the page being processed, in case any frontMatter data is required.

Example usage of `getSources` from the PlantUML plugin:

```js
{
 ...
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
}
```

### Advanced: Default plugins

MarkBind has a set of default plugins that it uses to carry out some of its features. These are enabled by default for every project and should be left alone.
Expand Down

6 changes: 3 additions & 3 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ program
 const addHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file add: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -131,7 +131,7 @@ program
 const changeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file change: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildAffectedSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -143,7 +143,7 @@ program
 const removeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file deletion: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.removeAsset(filePath);
Expand Down

17 changes: 17 additions & 0 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ function Page(pageConfig) {
 this.headings = {};
 this.headingIndexingLevel = pageConfig.headingIndexingLevel;
 this.includedFiles = new Set();
 this.pluginSourceFiles = new Set();
 this.keywords = {};
 this.navigableHeadings = {};
 this.pageSectionsHtml = {};
Expand DownExpand Up@@ -794,6 +795,7 @@ Page.prototype.generate = function (builtFiles) {
 })
 .then(result => removePageHeaderAndFooter(result))
 .then(result => addContentWrapper(result))
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
Expand DownExpand Up@@ -861,6 +863,21 @@ Page.prototype.getPluginConfig = function () {
 };
};

/**
 * Collects file sources provided by plugins for the page
 */
Page.prototype.collectPluginSources = function (content) {
 Object.entries(this.plugins).forEach(([pluginName, plugin]) => {
 if (plugin.getSources) {
 const sources = plugin.getSources(content, this.pluginsContext[pluginName] || {},
 this.frontMatter, this.getPluginConfig());
 sources.forEach(src => this.pluginSourceFiles.add(path.resolve(ensurePosix(src))));
 }
 });

 return content;
};

/**
 * Entry point for plugin pre-render
 */
Expand Down

16 changes: 15 additions & 1 deletion
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -699,6 +699,15 @@ function findDefaultPlugins() {
 }).map(file => path.parse(file).name);
}

/**
 * Checks if a specified file path is a plugin source file
 * @param filePath file path to check
 * @returns {boolean} whether the file path matches a plugin source file path
 */
Site.prototype.isPluginSourceFile = function (filePath) {
 return this.pages.some(page => page.pluginSourceFiles.has(filePath));
};

/**
 * Loads a plugin
 * @param plugin name of the plugin
Expand DownExpand Up@@ -827,7 +836,12 @@ Site.prototype.regenerateAffectedPages = function (filePaths) {
 }
 this._setTimestampVariable();
 this.pages.forEach((page) => {
 if (shouldRebuildAllPages || filePaths.some(filePath => page.includedFiles.has(filePath))) {
 if (shouldRebuildAllPages || filePaths.some((filePath) => {
 const isIncludedFile = page.includedFiles.has(filePath);
 const isPluginSourceFile = page.pluginSourceFiles.has(filePath);

 return isIncludedFile || isPluginSourceFile;
 })) {
 // eslint-disable-next-line no-param-reassign
 page.userDefinedVariablesMap = this.userDefinedVariablesMap;
 processingFiles.push(page.generate(builtFiles)
Expand Down

2 changes: 1 addition & 1 deletion
src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,5 +73,5 @@ module.exports = {
 requiredFiles: ['index.md', 'site.json', '_markbind/'],

 // src/util/fsUtil.js
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf', '.puml'],
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf'],
};

17 changes: 11 additions & 6 deletions
src/plugins/default/markbind-plugin-plantuml.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,12 +85,9 @@ function generateDiagram(src, cwf, config) {
 errorLog += errorMsg;
 });

 childProcess.on('close', (code) => {
 if (code !== 0) {
 logger.error(`${ERR_PROCESSING} ${rawDiagramPath}`);
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 }
 childProcess.on('exit', () => {
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 });
 });

Expand All@@ -99,6 +96,8 @@ function generateDiagram(src, cwf, config) {

module.exports = {
 preRender: (content, pluginContext, frontmatter, config) => {
 // Clear <puml> tags processed before for live reload
 processedDiagrams.clear();
 // Processes all <puml> tags
 const $ = cheerio.load(content, { xmlMode: true });
 $('puml').each((i, tag) => {
Expand All@@ -111,4 +110,10 @@ module.exports = {

 return $.html();
 },
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
};

28 changes: 28 additions & 0 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -465,6 +465,34 @@ <h1 id="markbind-plugin-pre-render">Markbind Plugin Pre-render<a class="fa fa-an
 <p>Node Modules Plugin Post-render</p>
 </div>
 <p><strong>Test search indexing</strong></p>
 <p><strong>Test PlantUML live reload without include</strong>
 <pic src="/test_site/diagrams/activity.png" alt="activity diagram"></pic>
 </p>
 <p><strong>Test PlantUML live reload with include</strong></p>
 <div>
 <p><strong>PlantUML Test</strong></p>
 <p><strong>Sequence Diagram</strong>
 <pic src="/test_site/diagrams/sequence.png"></pic>
 </p>
 <p><strong>Use Case Diagram</strong>
 <pic src="/test_site/diagrams/usecase.png"></pic>
 </p>
 <p><strong>Class Diagram</strong>
 <pic src="/test_site/diagrams/class.png"></pic>
 </p>
 <p><strong>Activity Diagram</strong>
 <pic src="/test_site/diagrams/activity.png"></pic>
 </p>
 <p><strong>Component Diagram</strong>
 <pic src="/test_site/diagrams/component.png"></pic>
 </p>
 <p><strong>State Diagram</strong>
 <pic src="/test_site/diagrams/state.png"></pic>
 </p>
 <p><strong>Object Diagram</strong>
 <pic src="/test_site/diagrams/object.png"></pic>
 </p>
 </div>
 <h2 class="no-index" id="level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed">Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed<a class="fa fa-anchor" href="#level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed"></a></h2>
 <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed">Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed<a class="fa fa-anchor" href="#level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed"></a></h6>
 <hr class="footnotes-sep">
Expand Down

8 changes: 7 additions & 1 deletion
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -276,6 +276,12 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd

**Test search indexing**

**Test PlantUML live reload without include**
<puml src="diagrams/activity.puml" alt="activity diagram" />

**Test PlantUML live reload with include**
<include src="testPlantUML.md" />

## Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed {.no-index}

###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}
###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}

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

Skip to content
Allow live reloading for plugin defined sources#955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

Dec 23, 2019
 Merged


Allow live reloading for plugin defined sources
#955
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


28 changes: 28 additions & 0 deletions
docs/userGuide/usingPlugins.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -143,6 +143,34 @@ This will add the following link and script elements to the page:
- `<script src="SCRIPT_LINK"></script>`
- `<script>alert("hello")</script>`

#### Live reload

By default, MarkBind treats `.html`, `.md`, `.mbd`, and `.mbdf` as source files, and will rebuild any
pages changed when serving the page.

During the `preRender` and `postRender` stages however, plugins may do custom processing using some other
source file types, as parsed from the raw Markdown, typically requiring rebuilding the site.

Hence, to add custom source files to watch, you can implement the `getSources()` method.
- `getSources(content, pluginContext, frontMatter)`: Returns an array of source file paths to watch. Called **before** a Markdown file's `preRender` function is called.
 - `content`: The raw Markdown of the current Markdown file (`.md`, `.mbd`, etc.).
 - `pluginContext`: User provided parameters for the plugin. This can be specified in the `site.json`.
 - `frontMatter`: The frontMatter of the page being processed, in case any frontMatter data is required.

Example usage of `getSources` from the PlantUML plugin:

```js
{
 ...
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
}
```

### Advanced: Default plugins

MarkBind has a set of default plugins that it uses to carry out some of its features. These are enabled by default for every project and should be left alone.
Expand Down

6 changes: 3 additions & 3 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ program
 const addHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file add: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -131,7 +131,7 @@ program
 const changeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file change: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildAffectedSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -143,7 +143,7 @@ program
 const removeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file deletion: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.removeAsset(filePath);
Expand Down

17 changes: 17 additions & 0 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ function Page(pageConfig) {
 this.headings = {};
 this.headingIndexingLevel = pageConfig.headingIndexingLevel;
 this.includedFiles = new Set();
 this.pluginSourceFiles = new Set();
 this.keywords = {};
 this.navigableHeadings = {};
 this.pageSectionsHtml = {};
Expand DownExpand Up@@ -794,6 +795,7 @@ Page.prototype.generate = function (builtFiles) {
 })
 .then(result => removePageHeaderAndFooter(result))
 .then(result => addContentWrapper(result))
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
Expand DownExpand Up@@ -861,6 +863,21 @@ Page.prototype.getPluginConfig = function () {
 };
};

/**
 * Collects file sources provided by plugins for the page
 */
Page.prototype.collectPluginSources = function (content) {
 Object.entries(this.plugins).forEach(([pluginName, plugin]) => {
 if (plugin.getSources) {
 const sources = plugin.getSources(content, this.pluginsContext[pluginName] || {},
 this.frontMatter, this.getPluginConfig());
 sources.forEach(src => this.pluginSourceFiles.add(path.resolve(ensurePosix(src))));
 }
 });

 return content;
};

/**
 * Entry point for plugin pre-render
 */
Expand Down

16 changes: 15 additions & 1 deletion
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -699,6 +699,15 @@ function findDefaultPlugins() {
 }).map(file => path.parse(file).name);
}

/**
 * Checks if a specified file path is a plugin source file
 * @param filePath file path to check
 * @returns {boolean} whether the file path matches a plugin source file path
 */
Site.prototype.isPluginSourceFile = function (filePath) {
 return this.pages.some(page => page.pluginSourceFiles.has(filePath));
};

/**
 * Loads a plugin
 * @param plugin name of the plugin
Expand DownExpand Up@@ -827,7 +836,12 @@ Site.prototype.regenerateAffectedPages = function (filePaths) {
 }
 this._setTimestampVariable();
 this.pages.forEach((page) => {
 if (shouldRebuildAllPages || filePaths.some(filePath => page.includedFiles.has(filePath))) {
 if (shouldRebuildAllPages || filePaths.some((filePath) => {
 const isIncludedFile = page.includedFiles.has(filePath);
 const isPluginSourceFile = page.pluginSourceFiles.has(filePath);

 return isIncludedFile || isPluginSourceFile;
 })) {
 // eslint-disable-next-line no-param-reassign
 page.userDefinedVariablesMap = this.userDefinedVariablesMap;
 processingFiles.push(page.generate(builtFiles)
Expand Down

2 changes: 1 addition & 1 deletion
src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,5 +73,5 @@ module.exports = {
 requiredFiles: ['index.md', 'site.json', '_markbind/'],

 // src/util/fsUtil.js
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf', '.puml'],
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf'],
};

17 changes: 11 additions & 6 deletions
src/plugins/default/markbind-plugin-plantuml.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,12 +85,9 @@ function generateDiagram(src, cwf, config) {
 errorLog += errorMsg;
 });

 childProcess.on('close', (code) => {
 if (code !== 0) {
 logger.error(`${ERR_PROCESSING} ${rawDiagramPath}`);
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 }
 childProcess.on('exit', () => {
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 });
 });

Expand All@@ -99,6 +96,8 @@ function generateDiagram(src, cwf, config) {

module.exports = {
 preRender: (content, pluginContext, frontmatter, config) => {
 // Clear <puml> tags processed before for live reload
 processedDiagrams.clear();
 // Processes all <puml> tags
 const $ = cheerio.load(content, { xmlMode: true });
 $('puml').each((i, tag) => {
Expand All@@ -111,4 +110,10 @@ module.exports = {

 return $.html();
 },
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
};

28 changes: 28 additions & 0 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -465,6 +465,34 @@ <h1 id="markbind-plugin-pre-render">Markbind Plugin Pre-render<a class="fa fa-an
 <p>Node Modules Plugin Post-render</p>
 </div>
 <p><strong>Test search indexing</strong></p>
 <p><strong>Test PlantUML live reload without include</strong>
 <pic src="/test_site/diagrams/activity.png" alt="activity diagram"></pic>
 </p>
 <p><strong>Test PlantUML live reload with include</strong></p>
 <div>
 <p><strong>PlantUML Test</strong></p>
 <p><strong>Sequence Diagram</strong>
 <pic src="/test_site/diagrams/sequence.png"></pic>
 </p>
 <p><strong>Use Case Diagram</strong>
 <pic src="/test_site/diagrams/usecase.png"></pic>
 </p>
 <p><strong>Class Diagram</strong>
 <pic src="/test_site/diagrams/class.png"></pic>
 </p>
 <p><strong>Activity Diagram</strong>
 <pic src="/test_site/diagrams/activity.png"></pic>
 </p>
 <p><strong>Component Diagram</strong>
 <pic src="/test_site/diagrams/component.png"></pic>
 </p>
 <p><strong>State Diagram</strong>
 <pic src="/test_site/diagrams/state.png"></pic>
 </p>
 <p><strong>Object Diagram</strong>
 <pic src="/test_site/diagrams/object.png"></pic>
 </p>
 </div>
 <h2 class="no-index" id="level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed">Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed<a class="fa fa-anchor" href="#level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed"></a></h2>
 <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed">Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed<a class="fa fa-anchor" href="#level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed"></a></h6>
 <hr class="footnotes-sep">
Expand Down

8 changes: 7 additions & 1 deletion
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -276,6 +276,12 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd

**Test search indexing**

**Test PlantUML live reload without include**
<puml src="diagrams/activity.puml" alt="activity diagram" />

**Test PlantUML live reload with include**
<include src="testPlantUML.md" />

## Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed {.no-index}

###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}
###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}

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

Skip to content
Allow live reloading for plugin defined sources#955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

Dec 23, 2019
 Merged


Allow live reloading for plugin defined sources
#955
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


28 changes: 28 additions & 0 deletions
docs/userGuide/usingPlugins.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -143,6 +143,34 @@ This will add the following link and script elements to the page:
- `<script src="SCRIPT_LINK"></script>`
- `<script>alert("hello")</script>`

#### Live reload

By default, MarkBind treats `.html`, `.md`, `.mbd`, and `.mbdf` as source files, and will rebuild any
pages changed when serving the page.

During the `preRender` and `postRender` stages however, plugins may do custom processing using some other
source file types, as parsed from the raw Markdown, typically requiring rebuilding the site.

Hence, to add custom source files to watch, you can implement the `getSources()` method.
- `getSources(content, pluginContext, frontMatter)`: Returns an array of source file paths to watch. Called **before** a Markdown file's `preRender` function is called.
 - `content`: The raw Markdown of the current Markdown file (`.md`, `.mbd`, etc.).
 - `pluginContext`: User provided parameters for the plugin. This can be specified in the `site.json`.
 - `frontMatter`: The frontMatter of the page being processed, in case any frontMatter data is required.

Example usage of `getSources` from the PlantUML plugin:

```js
{
 ...
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
}
```

### Advanced: Default plugins

MarkBind has a set of default plugins that it uses to carry out some of its features. These are enabled by default for every project and should be left alone.
Expand Down

6 changes: 3 additions & 3 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ program
 const addHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file add: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -131,7 +131,7 @@ program
 const changeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file change: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildAffectedSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -143,7 +143,7 @@ program
 const removeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file deletion: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.removeAsset(filePath);
Expand Down

17 changes: 17 additions & 0 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ function Page(pageConfig) {
 this.headings = {};
 this.headingIndexingLevel = pageConfig.headingIndexingLevel;
 this.includedFiles = new Set();
 this.pluginSourceFiles = new Set();
 this.keywords = {};
 this.navigableHeadings = {};
 this.pageSectionsHtml = {};
Expand DownExpand Up@@ -794,6 +795,7 @@ Page.prototype.generate = function (builtFiles) {
 })
 .then(result => removePageHeaderAndFooter(result))
 .then(result => addContentWrapper(result))
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
Expand DownExpand Up@@ -861,6 +863,21 @@ Page.prototype.getPluginConfig = function () {
 };
};

/**
 * Collects file sources provided by plugins for the page
 */
Page.prototype.collectPluginSources = function (content) {
 Object.entries(this.plugins).forEach(([pluginName, plugin]) => {
 if (plugin.getSources) {
 const sources = plugin.getSources(content, this.pluginsContext[pluginName] || {},
 this.frontMatter, this.getPluginConfig());
 sources.forEach(src => this.pluginSourceFiles.add(path.resolve(ensurePosix(src))));
 }
 });

 return content;
};

/**
 * Entry point for plugin pre-render
 */
Expand Down

16 changes: 15 additions & 1 deletion
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -699,6 +699,15 @@ function findDefaultPlugins() {
 }).map(file => path.parse(file).name);
}

/**
 * Checks if a specified file path is a plugin source file
 * @param filePath file path to check
 * @returns {boolean} whether the file path matches a plugin source file path
 */
Site.prototype.isPluginSourceFile = function (filePath) {
 return this.pages.some(page => page.pluginSourceFiles.has(filePath));
};

/**
 * Loads a plugin
 * @param plugin name of the plugin
Expand DownExpand Up@@ -827,7 +836,12 @@ Site.prototype.regenerateAffectedPages = function (filePaths) {
 }
 this._setTimestampVariable();
 this.pages.forEach((page) => {
 if (shouldRebuildAllPages || filePaths.some(filePath => page.includedFiles.has(filePath))) {
 if (shouldRebuildAllPages || filePaths.some((filePath) => {
 const isIncludedFile = page.includedFiles.has(filePath);
 const isPluginSourceFile = page.pluginSourceFiles.has(filePath);

 return isIncludedFile || isPluginSourceFile;
 })) {
 // eslint-disable-next-line no-param-reassign
 page.userDefinedVariablesMap = this.userDefinedVariablesMap;
 processingFiles.push(page.generate(builtFiles)
Expand Down

2 changes: 1 addition & 1 deletion
src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,5 +73,5 @@ module.exports = {
 requiredFiles: ['index.md', 'site.json', '_markbind/'],

 // src/util/fsUtil.js
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf', '.puml'],
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf'],
};

17 changes: 11 additions & 6 deletions
src/plugins/default/markbind-plugin-plantuml.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,12 +85,9 @@ function generateDiagram(src, cwf, config) {
 errorLog += errorMsg;
 });

 childProcess.on('close', (code) => {
 if (code !== 0) {
 logger.error(`${ERR_PROCESSING} ${rawDiagramPath}`);
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 }
 childProcess.on('exit', () => {
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 });
 });

Expand All@@ -99,6 +96,8 @@ function generateDiagram(src, cwf, config) {

module.exports = {
 preRender: (content, pluginContext, frontmatter, config) => {
 // Clear <puml> tags processed before for live reload
 processedDiagrams.clear();
 // Processes all <puml> tags
 const $ = cheerio.load(content, { xmlMode: true });
 $('puml').each((i, tag) => {
Expand All@@ -111,4 +110,10 @@ module.exports = {

 return $.html();
 },
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
};

28 changes: 28 additions & 0 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -465,6 +465,34 @@ <h1 id="markbind-plugin-pre-render">Markbind Plugin Pre-render<a class="fa fa-an
 <p>Node Modules Plugin Post-render</p>
 </div>
 <p><strong>Test search indexing</strong></p>
 <p><strong>Test PlantUML live reload without include</strong>
 <pic src="/test_site/diagrams/activity.png" alt="activity diagram"></pic>
 </p>
 <p><strong>Test PlantUML live reload with include</strong></p>
 <div>
 <p><strong>PlantUML Test</strong></p>
 <p><strong>Sequence Diagram</strong>
 <pic src="/test_site/diagrams/sequence.png"></pic>
 </p>
 <p><strong>Use Case Diagram</strong>
 <pic src="/test_site/diagrams/usecase.png"></pic>
 </p>
 <p><strong>Class Diagram</strong>
 <pic src="/test_site/diagrams/class.png"></pic>
 </p>
 <p><strong>Activity Diagram</strong>
 <pic src="/test_site/diagrams/activity.png"></pic>
 </p>
 <p><strong>Component Diagram</strong>
 <pic src="/test_site/diagrams/component.png"></pic>
 </p>
 <p><strong>State Diagram</strong>
 <pic src="/test_site/diagrams/state.png"></pic>
 </p>
 <p><strong>Object Diagram</strong>
 <pic src="/test_site/diagrams/object.png"></pic>
 </p>
 </div>
 <h2 class="no-index" id="level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed">Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed<a class="fa fa-anchor" href="#level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed"></a></h2>
 <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed">Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed<a class="fa fa-anchor" href="#level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed"></a></h6>
 <hr class="footnotes-sep">
Expand Down

8 changes: 7 additions & 1 deletion
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -276,6 +276,12 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd

**Test search indexing**

**Test PlantUML live reload without include**
<puml src="diagrams/activity.puml" alt="activity diagram" />

**Test PlantUML live reload with include**
<include src="testPlantUML.md" />

## Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed {.no-index}

###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}
###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}

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

Skip to content
Allow live reloading for plugin defined sources#955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

Dec 23, 2019
 Merged


Allow live reloading for plugin defined sources
#955
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


28 changes: 28 additions & 0 deletions
docs/userGuide/usingPlugins.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -143,6 +143,34 @@ This will add the following link and script elements to the page:
- `<script src="SCRIPT_LINK"></script>`
- `<script>alert("hello")</script>`

#### Live reload

By default, MarkBind treats `.html`, `.md`, `.mbd`, and `.mbdf` as source files, and will rebuild any
pages changed when serving the page.

During the `preRender` and `postRender` stages however, plugins may do custom processing using some other
source file types, as parsed from the raw Markdown, typically requiring rebuilding the site.

Hence, to add custom source files to watch, you can implement the `getSources()` method.
- `getSources(content, pluginContext, frontMatter)`: Returns an array of source file paths to watch. Called **before** a Markdown file's `preRender` function is called.
 - `content`: The raw Markdown of the current Markdown file (`.md`, `.mbd`, etc.).
 - `pluginContext`: User provided parameters for the plugin. This can be specified in the `site.json`.
 - `frontMatter`: The frontMatter of the page being processed, in case any frontMatter data is required.

Example usage of `getSources` from the PlantUML plugin:

```js
{
 ...
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
}
```

### Advanced: Default plugins

MarkBind has a set of default plugins that it uses to carry out some of its features. These are enabled by default for every project and should be left alone.
Expand Down

6 changes: 3 additions & 3 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ program
 const addHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file add: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -131,7 +131,7 @@ program
 const changeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file change: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildAffectedSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -143,7 +143,7 @@ program
 const removeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file deletion: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.removeAsset(filePath);
Expand Down

17 changes: 17 additions & 0 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ function Page(pageConfig) {
 this.headings = {};
 this.headingIndexingLevel = pageConfig.headingIndexingLevel;
 this.includedFiles = new Set();
 this.pluginSourceFiles = new Set();
 this.keywords = {};
 this.navigableHeadings = {};
 this.pageSectionsHtml = {};
Expand DownExpand Up@@ -794,6 +795,7 @@ Page.prototype.generate = function (builtFiles) {
 })
 .then(result => removePageHeaderAndFooter(result))
 .then(result => addContentWrapper(result))
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
Expand DownExpand Up@@ -861,6 +863,21 @@ Page.prototype.getPluginConfig = function () {
 };
};

/**
 * Collects file sources provided by plugins for the page
 */
Page.prototype.collectPluginSources = function (content) {
 Object.entries(this.plugins).forEach(([pluginName, plugin]) => {
 if (plugin.getSources) {
 const sources = plugin.getSources(content, this.pluginsContext[pluginName] || {},
 this.frontMatter, this.getPluginConfig());
 sources.forEach(src => this.pluginSourceFiles.add(path.resolve(ensurePosix(src))));
 }
 });

 return content;
};

/**
 * Entry point for plugin pre-render
 */
Expand Down

16 changes: 15 additions & 1 deletion
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -699,6 +699,15 @@ function findDefaultPlugins() {
 }).map(file => path.parse(file).name);
}

/**
 * Checks if a specified file path is a plugin source file
 * @param filePath file path to check
 * @returns {boolean} whether the file path matches a plugin source file path
 */
Site.prototype.isPluginSourceFile = function (filePath) {
 return this.pages.some(page => page.pluginSourceFiles.has(filePath));
};

/**
 * Loads a plugin
 * @param plugin name of the plugin
Expand DownExpand Up@@ -827,7 +836,12 @@ Site.prototype.regenerateAffectedPages = function (filePaths) {
 }
 this._setTimestampVariable();
 this.pages.forEach((page) => {
 if (shouldRebuildAllPages || filePaths.some(filePath => page.includedFiles.has(filePath))) {
 if (shouldRebuildAllPages || filePaths.some((filePath) => {
 const isIncludedFile = page.includedFiles.has(filePath);
 const isPluginSourceFile = page.pluginSourceFiles.has(filePath);

 return isIncludedFile || isPluginSourceFile;
 })) {
 // eslint-disable-next-line no-param-reassign
 page.userDefinedVariablesMap = this.userDefinedVariablesMap;
 processingFiles.push(page.generate(builtFiles)
Expand Down

2 changes: 1 addition & 1 deletion
src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,5 +73,5 @@ module.exports = {
 requiredFiles: ['index.md', 'site.json', '_markbind/'],

 // src/util/fsUtil.js
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf', '.puml'],
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf'],
};

17 changes: 11 additions & 6 deletions
src/plugins/default/markbind-plugin-plantuml.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,12 +85,9 @@ function generateDiagram(src, cwf, config) {
 errorLog += errorMsg;
 });

 childProcess.on('close', (code) => {
 if (code !== 0) {
 logger.error(`${ERR_PROCESSING} ${rawDiagramPath}`);
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 }
 childProcess.on('exit', () => {
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 });
 });

Expand All@@ -99,6 +96,8 @@ function generateDiagram(src, cwf, config) {

module.exports = {
 preRender: (content, pluginContext, frontmatter, config) => {
 // Clear <puml> tags processed before for live reload
 processedDiagrams.clear();
 // Processes all <puml> tags
 const $ = cheerio.load(content, { xmlMode: true });
 $('puml').each((i, tag) => {
Expand All@@ -111,4 +110,10 @@ module.exports = {

 return $.html();
 },
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
};

28 changes: 28 additions & 0 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -465,6 +465,34 @@ <h1 id="markbind-plugin-pre-render">Markbind Plugin Pre-render<a class="fa fa-an
 <p>Node Modules Plugin Post-render</p>
 </div>
 <p><strong>Test search indexing</strong></p>
 <p><strong>Test PlantUML live reload without include</strong>
 <pic src="/test_site/diagrams/activity.png" alt="activity diagram"></pic>
 </p>
 <p><strong>Test PlantUML live reload with include</strong></p>
 <div>
 <p><strong>PlantUML Test</strong></p>
 <p><strong>Sequence Diagram</strong>
 <pic src="/test_site/diagrams/sequence.png"></pic>
 </p>
 <p><strong>Use Case Diagram</strong>
 <pic src="/test_site/diagrams/usecase.png"></pic>
 </p>
 <p><strong>Class Diagram</strong>
 <pic src="/test_site/diagrams/class.png"></pic>
 </p>
 <p><strong>Activity Diagram</strong>
 <pic src="/test_site/diagrams/activity.png"></pic>
 </p>
 <p><strong>Component Diagram</strong>
 <pic src="/test_site/diagrams/component.png"></pic>
 </p>
 <p><strong>State Diagram</strong>
 <pic src="/test_site/diagrams/state.png"></pic>
 </p>
 <p><strong>Object Diagram</strong>
 <pic src="/test_site/diagrams/object.png"></pic>
 </p>
 </div>
 <h2 class="no-index" id="level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed">Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed<a class="fa fa-anchor" href="#level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed"></a></h2>
 <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed">Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed<a class="fa fa-anchor" href="#level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed"></a></h6>
 <hr class="footnotes-sep">
Expand Down

8 changes: 7 additions & 1 deletion
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -276,6 +276,12 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd

**Test search indexing**

**Test PlantUML live reload without include**
<puml src="diagrams/activity.puml" alt="activity diagram" />

**Test PlantUML live reload with include**
<include src="testPlantUML.md" />

## Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed {.no-index}

###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}
###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}

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

Skip to content
Allow live reloading for plugin defined sources#955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yamgent
merged 1 commit into

from

Dec 23, 2019
 Merged


Allow live reloading for plugin defined sources
#955
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


28 changes: 28 additions & 0 deletions
docs/userGuide/usingPlugins.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -143,6 +143,34 @@ This will add the following link and script elements to the page:
- `<script src="SCRIPT_LINK"></script>`
- `<script>alert("hello")</script>`

#### Live reload

By default, MarkBind treats `.html`, `.md`, `.mbd`, and `.mbdf` as source files, and will rebuild any
pages changed when serving the page.

During the `preRender` and `postRender` stages however, plugins may do custom processing using some other
source file types, as parsed from the raw Markdown, typically requiring rebuilding the site.

Hence, to add custom source files to watch, you can implement the `getSources()` method.
- `getSources(content, pluginContext, frontMatter)`: Returns an array of source file paths to watch. Called **before** a Markdown file's `preRender` function is called.
 - `content`: The raw Markdown of the current Markdown file (`.md`, `.mbd`, etc.).
 - `pluginContext`: User provided parameters for the plugin. This can be specified in the `site.json`.
 - `frontMatter`: The frontMatter of the page being processed, in case any frontMatter data is required.

Example usage of `getSources` from the PlantUML plugin:

```js
{
 ...
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
}
```

### Advanced: Default plugins

MarkBind has a set of default plugins that it uses to carry out some of its features. These are enabled by default for every project and should be left alone.
Expand Down

6 changes: 3 additions & 3 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,7 +119,7 @@ program
 const addHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file add: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -131,7 +131,7 @@ program
 const changeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file change: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildAffectedSourceFiles(filePath);
 }
 return site.buildAsset(filePath);
Expand All@@ -143,7 +143,7 @@ program
 const removeHandler = (filePath) => {
 logger.info(`[${new Date().toLocaleTimeString()}] Reload for file deletion: ${filePath}`);
 Promise.resolve('').then(() => {
 if (fsUtil.isSourceFile(filePath)) {
 if (fsUtil.isSourceFile(filePath) || site.isPluginSourceFile(filePath)) {
 return site.rebuildSourceFiles(filePath);
 }
 return site.removeAsset(filePath);
Expand Down

17 changes: 17 additions & 0 deletions
src/Page.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,7 @@ function Page(pageConfig) {
 this.headings = {};
 this.headingIndexingLevel = pageConfig.headingIndexingLevel;
 this.includedFiles = new Set();
 this.pluginSourceFiles = new Set();
 this.keywords = {};
 this.navigableHeadings = {};
 this.pageSectionsHtml = {};
Expand DownExpand Up@@ -794,6 +795,7 @@ Page.prototype.generate = function (builtFiles) {
 })
 .then(result => removePageHeaderAndFooter(result))
 .then(result => addContentWrapper(result))
 .then(result => this.collectPluginSources(result))
 .then(result => this.preRender(result))
 .then(result => this.insertSiteNav((result)))
 .then(result => this.insertHeaderFile(result))
Expand DownExpand Up@@ -861,6 +863,21 @@ Page.prototype.getPluginConfig = function () {
 };
};

/**
 * Collects file sources provided by plugins for the page
 */
Page.prototype.collectPluginSources = function (content) {
 Object.entries(this.plugins).forEach(([pluginName, plugin]) => {
 if (plugin.getSources) {
 const sources = plugin.getSources(content, this.pluginsContext[pluginName] || {},
 this.frontMatter, this.getPluginConfig());
 sources.forEach(src => this.pluginSourceFiles.add(path.resolve(ensurePosix(src))));
 }
 });

 return content;
};

/**
 * Entry point for plugin pre-render
 */
Expand Down

16 changes: 15 additions & 1 deletion
src/Site.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -699,6 +699,15 @@ function findDefaultPlugins() {
 }).map(file => path.parse(file).name);
}

/**
 * Checks if a specified file path is a plugin source file
 * @param filePath file path to check
 * @returns {boolean} whether the file path matches a plugin source file path
 */
Site.prototype.isPluginSourceFile = function (filePath) {
 return this.pages.some(page => page.pluginSourceFiles.has(filePath));
};

/**
 * Loads a plugin
 * @param plugin name of the plugin
Expand DownExpand Up@@ -827,7 +836,12 @@ Site.prototype.regenerateAffectedPages = function (filePaths) {
 }
 this._setTimestampVariable();
 this.pages.forEach((page) => {
 if (shouldRebuildAllPages || filePaths.some(filePath => page.includedFiles.has(filePath))) {
 if (shouldRebuildAllPages || filePaths.some((filePath) => {
 const isIncludedFile = page.includedFiles.has(filePath);
 const isPluginSourceFile = page.pluginSourceFiles.has(filePath);

 return isIncludedFile || isPluginSourceFile;
 })) {
 // eslint-disable-next-line no-param-reassign
 page.userDefinedVariablesMap = this.userDefinedVariablesMap;
 processingFiles.push(page.generate(builtFiles)
Expand Down

2 changes: 1 addition & 1 deletion
src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,5 +73,5 @@ module.exports = {
 requiredFiles: ['index.md', 'site.json', '_markbind/'],

 // src/util/fsUtil.js
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf', '.puml'],
 sourceFileExtNames: ['.html', '.md', '.mbd', '.mbdf'],
};

17 changes: 11 additions & 6 deletions
src/plugins/default/markbind-plugin-plantuml.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,12 +85,9 @@ function generateDiagram(src, cwf, config) {
 errorLog += errorMsg;
 });

 childProcess.on('close', (code) => {
 if (code !== 0) {
 logger.error(`${ERR_PROCESSING} ${rawDiagramPath}`);
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 }
 childProcess.on('exit', () => {
 // This goes to the log file, but not shown on the console
 logger.debug(errorLog);
 });
 });

Expand All@@ -99,6 +96,8 @@ function generateDiagram(src, cwf, config) {

module.exports = {
 preRender: (content, pluginContext, frontmatter, config) => {
 // Clear <puml> tags processed before for live reload
 processedDiagrams.clear();
 // Processes all <puml> tags
 const $ = cheerio.load(content, { xmlMode: true });
 $('puml').each((i, tag) => {
Expand All@@ -111,4 +110,10 @@ module.exports = {

 return $.html();
 },
 getSources: (content) => {
 // Add all src attributes in <puml> tags to watch list
 const $ = cheerio.load(content, { xmlMode: true });

 return $('puml').map((i, tag) => tag.attribs.src).get();
 },
};

28 changes: 28 additions & 0 deletions
test/functional/test_site/expected/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -465,6 +465,34 @@ <h1 id="markbind-plugin-pre-render">Markbind Plugin Pre-render<a class="fa fa-an
 <p>Node Modules Plugin Post-render</p>
 </div>
 <p><strong>Test search indexing</strong></p>
 <p><strong>Test PlantUML live reload without include</strong>
 <pic src="/test_site/diagrams/activity.png" alt="activity diagram"></pic>
 </p>
 <p><strong>Test PlantUML live reload with include</strong></p>
 <div>
 <p><strong>PlantUML Test</strong></p>
 <p><strong>Sequence Diagram</strong>
 <pic src="/test_site/diagrams/sequence.png"></pic>
 </p>
 <p><strong>Use Case Diagram</strong>
 <pic src="/test_site/diagrams/usecase.png"></pic>
 </p>
 <p><strong>Class Diagram</strong>
 <pic src="/test_site/diagrams/class.png"></pic>
 </p>
 <p><strong>Activity Diagram</strong>
 <pic src="/test_site/diagrams/activity.png"></pic>
 </p>
 <p><strong>Component Diagram</strong>
 <pic src="/test_site/diagrams/component.png"></pic>
 </p>
 <p><strong>State Diagram</strong>
 <pic src="/test_site/diagrams/state.png"></pic>
 </p>
 <p><strong>Object Diagram</strong>
 <pic src="/test_site/diagrams/object.png"></pic>
 </p>
 </div>
 <h2 class="no-index" id="level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed">Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed<a class="fa fa-anchor" href="#level-2-header-inside-headingsearchindex-with-no-index-attribute-should-not-be-indexed"></a></h2>
 <h6 class="always-index" id="level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed">Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed<a class="fa fa-anchor" href="#level-6-header-outside-headingsearchindex-with-always-index-attribute-should-be-indexed"></a></h6>
 <hr class="footnotes-sep">
Expand Down

8 changes: 7 additions & 1 deletion
test/functional/test_site/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -276,6 +276,12 @@ tags: ["tag-frontmatter-shown", "tag-included-file", "+tag-exp*", "-tag-exp-hidd

**Test search indexing**

**Test PlantUML live reload without include**
<puml src="diagrams/activity.puml" alt="activity diagram" />

**Test PlantUML live reload with include**
<include src="testPlantUML.md" />

## Level 2 header (inside headingSearchIndex) with no-index attribute should not be indexed {.no-index}

###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}
###### Level 6 header (outside headingSearchIndex) with always-index attribute should be indexed {.always-index}