Skip to content

Remove variable syntax for icons #864

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
Chng-Zhi-Xuan merged 4 commits into from
May 27, 2019
Merged

Remove variable syntax for icons #864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be0d0a2
Asset: remove icon .csv files
Chng-Zhi-Xuan May 21, 2019
0c40f60
Site: remove variable syntax for icons
Chng-Zhi-Xuan May 21, 2019
fb6c75a
Test: update Site.test.js json directories
Chng-Zhi-Xuan May 21, 2019
53e2823
Docs: Fix icon exmaple
Chng-Zhi-Xuan May 21, 2019
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
2 changes: 1 addition & 1 deletion docs/userGuide/syntax/icons.mbdf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Please use the new :prefix-name: syntax instead.
1. Construct the MarkBind name for the selected icon by adding the _type prefix_.
Note: Font Awesome has three different styles for their icons, each with their own type prefix. Here is an example from each type:
* _Solid_ (prefix: `fas-`) e.g., :fas-file-code: (actual name `file-code`, MarkBind name `fas-file-code`)
* _Regular_ (prefix: `far-`) e.g., :fas-file-code: (actual name `file-code`, MarkBind name `far-file-code`)
* _Regular_ (prefix: `far-`) e.g., :far-file-code: (actual name `file-code`, MarkBind name `far-file-code`)
* _Brands_ (prefix: `fab-`): e.g., :fab-github-alt: (actual name `github-alt`, MarkBind name `fab-github-alt`)

1. Insert MarkBind name for the icon enclosed within colons to get the icon in your page.<br>
Expand Down
24 changes: 1 addition & 23 deletions src/Site.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,8 @@ const ABOUT_MARKDOWN_FILE = 'about.md';
const BUILT_IN_PLUGIN_FOLDER_NAME = 'plugins';
const BUILT_IN_DEFAULT_PLUGIN_FOLDER_NAME = 'plugins/default';
const FAVICON_DEFAULT_PATH = 'favicon.ico';
const FONT_AWESOME_PATH = 'asset/font-awesome.csv';
const FOOTER_PATH = '_markbind/footers/footer.md';
const HEADER_PATH = '_markbind/headers/header.md';
const GLYPHICONS_PATH = 'asset/glyphicons.csv';
const HEAD_FOLDER_PATH = '_markbind/head';
const INDEX_MARKDOWN_FILE = 'index.md';
const MARKBIND_PLUGIN_PREFIX = 'markbind-plugin-';
Expand Down Expand Up @@ -220,25 +218,6 @@ function rejectHandler(reject, error, removeFolders) {
});
}

function getIconsMap() {
const fontAwesomePath = path.join(__dirname, FONT_AWESOME_PATH);
const glyphiconsPath = path.join(__dirname, GLYPHICONS_PATH);
const fontAwesomeClasses = fs.readFileSync(fontAwesomePath, 'utf8').trimRight().split(/\r?\n/);
const glyphiconsClasses = fs.readFileSync(glyphiconsPath, 'utf8').trimRight().split(/\r?\n/);
const iconsMap = {};
fontAwesomeClasses.forEach((fontAwesomeClass) => {
const name = fontAwesomeClass.replace(' fa', '').replace(/-/g, '_');
const html = `<span class='${fontAwesomeClass}'></span>`;
iconsMap[name] = html;
});
glyphiconsClasses.forEach((glyphiconClass) => {
const name = glyphiconClass.replace(/-/g, '_');
const html = `<span class='glyphicon ${glyphiconClass}' aria-hidden='true'></span>`;
iconsMap[name] = html;
});
return iconsMap;
}

function setExtension(filename, ext) {
return path.join(
path.dirname(filename),
Expand Down Expand Up @@ -665,12 +644,11 @@ Site.prototype.collectUserDefinedVariablesMap = function () {
// The key is the base directory of the site/subsites,
// while the value is a mapping of user defined variables
this.userDefinedVariablesMap = {};
const iconsMap = getIconsMap();
const markbindVariable = { MarkBind: MARKBIND_LINK_HTML };

this.baseUrlMap.forEach((base) => {
const userDefinedVariables = {};
Object.assign(userDefinedVariables, iconsMap, markbindVariable);
Object.assign(userDefinedVariables, markbindVariable);

let content;
try {
Expand Down
Loading