Reorganize constants in packages/core#1987

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
jonahtanjz merged 1 commit into from
Aug 11, 2022
Merged

Reorganize constants in packages/core #1987

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
2 changes: 1 addition & 1 deletion packages/core/src/Layout/LayoutManager.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ const { Layout } = require('./Layout');

const logger = require('../utils/logger');

const { FRONT_MATTER_NONE_ATTR } = require('../Page/constants');
const FRONT_MATTER_NONE_ATTR = 'none';

class LayoutManager {
constructor(config) {
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/Layout/index.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,6 @@ const { LayoutManager } = require('./LayoutManager');
module.exports = {
Layout,
LayoutManager,
LAYOUT_DEFAULT_NAME: 'default.md',
LAYOUT_FOLDER_PATH: '_markbind/layouts',
};
31 changes: 0 additions & 31 deletions packages/core/src/Page/constants.js
View file
Open in desktop

This file was deleted.

26 changes: 13 additions & 13 deletions packages/core/src/Page/index.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,16 +20,18 @@ const logger = require('../utils/logger');

const PACKAGE_VERSION = require('../../package.json').version;

const {
PAGE_NAV_ID,
PAGE_NAV_TITLE_CLASS,
TITLE_PREFIX_SEPARATOR,
TITLE_SUFFIX_SEPARATOR,
} = require('./constants');

const {
LAYOUT_DEFAULT_NAME,
} = require('../constants');
} = require('../Layout');

const TITLE_PREFIX_SEPARATOR = ' - ';
const TITLE_SUFFIX_SEPARATOR = ' - ';

const PAGE_NAV_ID = 'mb-page-nav';
const PAGE_NAV_TITLE_CLASS = 'page-nav-title';

const SCROLL_TO_TOP_BUTTON_HTML = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" '
+ 'id="scroll-top-button" onclick="handleScrollTop()" aria-hidden="true"></i>';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

Expand DownExpand Up@@ -103,7 +105,7 @@ class Page {
*/

/**
* The layout to use for this page, which may be further mutated in {@link processFrontMatter.}
* The layout to use for this page, which may be further mutated in {@link processFrontMatter}.
* @type {string}
*/
this.layout = this.pageConfig.layout;
Expand DownExpand Up@@ -435,7 +437,7 @@ class Page {
portal-ing it into the mobile page nav.
*/
return `${pageNavTitleHtml}\n`
+ `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="mb-page-nav"`
+ `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="${PAGE_NAV_ID}"`
+ ' class="nav nav-pills flex-column my-0 small no-flex-wrap">\n'
+ `${pageNavHeadingHTML}\n`
+ '</overlay-source>\n';
Expand DownExpand Up@@ -542,9 +544,7 @@ class Page {
}

static addScrollToTopButton(pageData) {
const button = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" id="scroll-top-button" '
+ 'onclick="handleScrollTop()" aria-hidden="true"></i>';
return `${pageData}\n${button}`;
return `${pageData}\n${SCROLL_TO_TOP_BUTTON_HTML}`;
}

/**
Expand Down
4 changes: 1 addition & 3 deletions packages/core/src/Site/SiteConfig.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
const logger = require('../utils/logger');

const {
HEADING_INDEXING_LEVEL_DEFAULT,
} = require('./constants');
const HEADING_INDEXING_LEVEL_DEFAULT = 3;

/**
* Represents a read only site config read from the site configuration file,
Expand Down
18 changes: 0 additions & 18 deletions packages/core/src/Site/constants.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
module.exports = {
CONFIG_FOLDER_NAME: '_markbind',
HEADING_INDEXING_LEVEL_DEFAULT: 3,
SITE_FOLDER_NAME: '_site',
TEMP_FOLDER_NAME: '.temp',
TEMPLATE_SITE_ASSET_FOLDER_NAME: 'markbind',

ABOUT_MARKDOWN_FILE: 'about.md',
FAVICON_DEFAULT_PATH: 'favicon.ico',
INDEX_MARKDOWN_FILE: 'index.md',
MAX_CONCURRENT_PAGE_GENERATION_PROMISES: 4,
PAGE_TEMPLATE_NAME: 'page.njk',
SITE_CONFIG_NAME: 'site.json',
SITE_DATA_NAME: 'siteData.json',
LAYOUT_SITE_FOLDER_NAME: 'layouts',
LAZY_LOADING_SITE_FILE_NAME: 'LazyLiveReloadLoadingSite.html',
LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT: 30000,
LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT: 5000,
USER_VARIABLES_PATH: '_markbind/variables.md',
WIKI_SITE_NAV_PATH: '_Sidebar.md',
WIKI_FOOTER_PATH: '_Footer.md',
MARKBIND_WEBSITE_URL: 'https://markbind.org/',
};
50 changes: 23 additions & 27 deletions packages/core/src/Site/index.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ const { PageConfig } = require('../Page/PageConfig');
const VariableProcessor = require('../variables/VariableProcessor');
const VariableRenderer = require('../variables/VariableRenderer');
const { ExternalManager } = require('../External/ExternalManager');
const { LayoutManager } = require('../Layout');
const { LayoutManager, LAYOUT_DEFAULT_NAME, LAYOUT_FOLDER_PATH } = require('../Layout');
const { SiteLinkManager } = require('../html/SiteLinkManager');
const { PluginManager } = require('../plugins/PluginManager');
const Template = require('../../template/template');
Expand All@@ -24,11 +24,7 @@ const { delay } = require('../utils/delay');
const fsUtil = require('../utils/fsUtil');
const gitUtil = require('../utils/git');
const logger = require('../utils/logger');

const {
LAYOUT_DEFAULT_NAME,
LAYOUT_FOLDER_PATH,
} = require('../constants');
const { SITE_CONFIG_NAME, INDEX_MARKDOWN_FILE, LAZY_LOADING_SITE_FILE_NAME } = require('./constants');

const _ = {};
_.difference = require('lodash/difference');
Expand All@@ -50,27 +46,26 @@ url.join = path.posix.join;

const MARKBIND_VERSION = require('../../package.json').version;

const {
ABOUT_MARKDOWN_FILE,
CONFIG_FOLDER_NAME,
FAVICON_DEFAULT_PATH,
INDEX_MARKDOWN_FILE,
LAYOUT_SITE_FOLDER_NAME,
LAZY_LOADING_SITE_FILE_NAME,
LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT,
LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT,
MARKBIND_WEBSITE_URL,
MAX_CONCURRENT_PAGE_GENERATION_PROMISES,
PAGE_TEMPLATE_NAME,
SITE_CONFIG_NAME,
SITE_DATA_NAME,
SITE_FOLDER_NAME,
TEMP_FOLDER_NAME,
TEMPLATE_SITE_ASSET_FOLDER_NAME,
USER_VARIABLES_PATH,
WIKI_SITE_NAV_PATH,
WIKI_FOOTER_PATH,
} = require('./constants');
const CONFIG_FOLDER_NAME = '_markbind';
const SITE_FOLDER_NAME = '_site';
const TEMP_FOLDER_NAME = '.temp';
const TEMPLATE_SITE_ASSET_FOLDER_NAME = 'markbind';
const LAYOUT_SITE_FOLDER_NAME = 'layouts';

const ABOUT_MARKDOWN_FILE = 'about.md';
const FAVICON_DEFAULT_PATH = 'favicon.ico';
const USER_VARIABLES_PATH = '_markbind/variables.md';

const PAGE_TEMPLATE_NAME = 'page.njk';
const SITE_DATA_NAME = 'siteData.json';

const WIKI_SITE_NAV_PATH = '_Sidebar.md';
const WIKI_FOOTER_PATH = '_Footer.md';

const MAX_CONCURRENT_PAGE_GENERATION_PROMISES = 4;

const LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT = 30000;
const LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT = 5000;

function getBootswatchThemePath(theme) {
return require.resolve(`bootswatch/dist/${theme}/bootstrap.min.css`);
Expand DownExpand Up@@ -104,6 +99,7 @@ const HIGHLIGHT_ASSETS = {
const ABOUT_MARKDOWN_DEFAULT = '# About\n'
+ 'Welcome to your **About Us** page.\n';

const MARKBIND_WEBSITE_URL = 'https://markbind.org/';
const MARKBIND_LINK_HTML = `<a href='${MARKBIND_WEBSITE_URL}'>MarkBind ${MARKBIND_VERSION}</a>`;

class Site {
Expand Down
12 changes: 0 additions & 12 deletions packages/core/src/constants.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
module.exports = {
// Page.js and Site.js
LAYOUT_DEFAULT_NAME: 'default.md',
LAYOUT_FOLDER_PATH: '_markbind/layouts',

// packages/core/src/Parser.js
ATTRIB_CWF: 'cwf',

BOILERPLATE_FOLDER_NAME: '_markbind/boilerplates',

// packages/core/src/plugins/algolia.js
ALGOLIA_CSS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css',
ALGOLIA_JS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js',
ALGOLIA_INPUT_SELECTOR: '#algolia-search-input',
};
4 changes: 2 additions & 2 deletions packages/core/src/html/NodeProcessor.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,12 +28,12 @@ const { createErrorNode } = require('./elements');
const fsUtil = require('../utils/fsUtil');
const logger = require('../utils/logger');

const { FRONT_MATTER_FENCE } = require('../Page/constants');

const {
ATTRIB_CWF,
} = require('../constants');

const FRONT_MATTER_FENCE = '---';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

class NodeProcessor {
Expand Down
32 changes: 20 additions & 12 deletions packages/core/src/html/siteAndPageNavProcessor.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,25 @@ const { v4: uuidv4 } = require('uuid');
const cheerio = require('cheerio'); require('../patches/htmlparser2');
const md = require('../lib/markdown-it');

const {
SITE_NAV_EMPTY_LINE_REGEX,
SITE_NAV_LIST_CLASS,
SITE_NAV_LIST_CLASS_ROOT,
SITE_NAV_LIST_ITEM_CLASS,
SITE_NAV_DEFAULT_LIST_ITEM_CLASS,
SITE_NAV_CUSTOM_LIST_ITEM_CLASS,
SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX,
SITE_NAV_DROPDOWN_ICON_ROTATED_HTML,
SITE_NAV_DROPDOWN_ICON_HTML,
} = require('../Page/constants');
const SITE_NAV_ID = 'site-nav';
const SITE_NAV_EMPTY_LINE_REGEX = /\r?\n\s*\r?\n/g;

const SITE_NAV_LIST_ITEM_CLASS = 'site-nav-list-item';
const SITE_NAV_LIST_CLASS = 'site-nav-list';
const SITE_NAV_LIST_CLASS_ROOT = 'site-nav-list-root';

const SITE_NAV_DEFAULT_LIST_ITEM_CLASS = 'site-nav-default-list-item';
const SITE_NAV_CUSTOM_LIST_ITEM_CLASS = 'site-nav-custom-list-item';

const SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX = /:expanded:/g;
const SITE_NAV_DROPDOWN_ICON_HTML = '<i class="site-nav-dropdown-btn-icon" '
+ 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
+ '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
+ '</i>';
const SITE_NAV_DROPDOWN_ICON_ROTATED_HTML = '<i class="site-nav-dropdown-btn-icon site-nav-rotate-icon" '
+ 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
+ '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
+ '</i>';

/**
* Replaces and stores a uuid identifier to the only page-nav element, if there is one.
Expand DownExpand Up@@ -130,7 +138,7 @@ function addOverlayPortalSource(node, to) {
* This component portals said element into the mobile navbar menus as needed.
*/
function addSitePageNavPortal(node) {
if (node.attribs.id === 'site-nav' || node.attribs.id === 'page-nav') {
if (node.attribs.id === SITE_NAV_ID || node.attribs.id === 'page-nav') {
addOverlayPortalSource(node, node.attribs.id);
} else if (node.attribs['mb-site-nav']) {
addOverlayPortalSource(node, 'mb-site-nav');
Expand Down
8 changes: 3 additions & 5 deletions packages/core/src/plugins/algolia.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
const cheerio = module.parent.require('cheerio');

const {
ALGOLIA_CSS_URL,
ALGOLIA_JS_URL,
ALGOLIA_INPUT_SELECTOR,
} = require('../constants');
const ALGOLIA_CSS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css';
const ALGOLIA_JS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js';
const ALGOLIA_INPUT_SELECTOR = '#algolia-search-input';

function buildAlgoliaInitScript(pluginContext) {
return `<script>
Expand Down
4 changes: 1 addition & 3 deletions packages/core/src/utils/urlUtil.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import path from 'path';
import pathIsInside from 'path-is-inside';

const {
BOILERPLATE_FOLDER_NAME,
} = require('../constants');
const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

/**
* Calculates the absolute path of of the immediate parent site of the specified filePath.
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} 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
Reorganize constants in packages/core#1987

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

jonahtanjz
merged 1 commit into

from

Aug 11, 2022
 Merged


Reorganize constants in packages/core
#1987
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


2 changes: 1 addition & 1 deletion
packages/core/src/Layout/LayoutManager.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ const { Layout } = require('./Layout');

const logger = require('../utils/logger');

const { FRONT_MATTER_NONE_ATTR } = require('../Page/constants');
const FRONT_MATTER_NONE_ATTR = 'none';

class LayoutManager {
 constructor(config) {
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/Layout/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,6 @@ const { LayoutManager } = require('./LayoutManager');
module.exports = {
 Layout,
 LayoutManager,
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',
};

31 changes: 0 additions & 31 deletions
packages/core/src/Page/constants.js

View file


Open in desktop


This file was deleted.


26 changes: 13 additions & 13 deletions
packages/core/src/Page/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,16 +20,18 @@ const logger = require('../utils/logger');

const PACKAGE_VERSION = require('../../package.json').version;

const {
 PAGE_NAV_ID,
 PAGE_NAV_TITLE_CLASS,
 TITLE_PREFIX_SEPARATOR,
 TITLE_SUFFIX_SEPARATOR,
} = require('./constants');

const {
 LAYOUT_DEFAULT_NAME,
} = require('../constants');
} = require('../Layout');

const TITLE_PREFIX_SEPARATOR = ' - ';
const TITLE_SUFFIX_SEPARATOR = ' - ';

const PAGE_NAV_ID = 'mb-page-nav';
const PAGE_NAV_TITLE_CLASS = 'page-nav-title';

const SCROLL_TO_TOP_BUTTON_HTML = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" '
 + 'id="scroll-top-button" onclick="handleScrollTop()" aria-hidden="true"></i>';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

Expand DownExpand Up@@ -103,7 +105,7 @@ class Page {
 */

 /**
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter.}
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter}.
 * @type {string}
 */
 this.layout = this.pageConfig.layout;
Expand DownExpand Up@@ -435,7 +437,7 @@ class Page {
 portal-ing it into the mobile page nav.
 */
 return `${pageNavTitleHtml}\n`
+ `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="mb-page-nav"`
 + `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="${PAGE_NAV_ID}"`
 + ' class="nav nav-pills flex-column my-0 small no-flex-wrap">\n'
 + `${pageNavHeadingHTML}\n`
 + '</overlay-source>\n';
Expand DownExpand Up@@ -542,9 +544,7 @@ class Page {
 }

 static addScrollToTopButton(pageData) {
 const button = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" id="scroll-top-button" '
 + 'onclick="handleScrollTop()" aria-hidden="true"></i>';
 return `${pageData}\n${button}`;
 return `${pageData}\n${SCROLL_TO_TOP_BUTTON_HTML}`;
 }

 /**
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/Site/SiteConfig.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
const logger = require('../utils/logger');

const {
 HEADING_INDEXING_LEVEL_DEFAULT,
} = require('./constants');
const HEADING_INDEXING_LEVEL_DEFAULT = 3;

/**
 * Represents a read only site config read from the site configuration file,
Expand Down

18 changes: 0 additions & 18 deletions
packages/core/src/Site/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
module.exports = {
 CONFIG_FOLDER_NAME: '_markbind',
 HEADING_INDEXING_LEVEL_DEFAULT: 3,
 SITE_FOLDER_NAME: '_site',
 TEMP_FOLDER_NAME: '.temp',
 TEMPLATE_SITE_ASSET_FOLDER_NAME: 'markbind',

 ABOUT_MARKDOWN_FILE: 'about.md',
 FAVICON_DEFAULT_PATH: 'favicon.ico',
 INDEX_MARKDOWN_FILE: 'index.md',
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES: 4,
 PAGE_TEMPLATE_NAME: 'page.njk',
 SITE_CONFIG_NAME: 'site.json',
 SITE_DATA_NAME: 'siteData.json',
 LAYOUT_SITE_FOLDER_NAME: 'layouts',
 LAZY_LOADING_SITE_FILE_NAME: 'LazyLiveReloadLoadingSite.html',
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT: 30000,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT: 5000,
 USER_VARIABLES_PATH: '_markbind/variables.md',
 WIKI_SITE_NAV_PATH: '_Sidebar.md',
 WIKI_FOOTER_PATH: '_Footer.md',
 MARKBIND_WEBSITE_URL: 'https://markbind.org/',
};

50 changes: 23 additions & 27 deletions
packages/core/src/Site/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ const { PageConfig } = require('../Page/PageConfig');
const VariableProcessor = require('../variables/VariableProcessor');
const VariableRenderer = require('../variables/VariableRenderer');
const { ExternalManager } = require('../External/ExternalManager');
const { LayoutManager } = require('../Layout');
const { LayoutManager, LAYOUT_DEFAULT_NAME, LAYOUT_FOLDER_PATH } = require('../Layout');
const { SiteLinkManager } = require('../html/SiteLinkManager');
const { PluginManager } = require('../plugins/PluginManager');
const Template = require('../../template/template');
Expand All@@ -24,11 +24,7 @@ const { delay } = require('../utils/delay');
const fsUtil = require('../utils/fsUtil');
const gitUtil = require('../utils/git');
const logger = require('../utils/logger');

const {
 LAYOUT_DEFAULT_NAME,
 LAYOUT_FOLDER_PATH,
} = require('../constants');
const { SITE_CONFIG_NAME, INDEX_MARKDOWN_FILE, LAZY_LOADING_SITE_FILE_NAME } = require('./constants');

const _ = {};
_.difference = require('lodash/difference');
Expand All@@ -50,27 +46,26 @@ url.join = path.posix.join;

const MARKBIND_VERSION = require('../../package.json').version;

const {
 ABOUT_MARKDOWN_FILE,
 CONFIG_FOLDER_NAME,
 FAVICON_DEFAULT_PATH,
 INDEX_MARKDOWN_FILE,
 LAYOUT_SITE_FOLDER_NAME,
 LAZY_LOADING_SITE_FILE_NAME,
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT,
 MARKBIND_WEBSITE_URL,
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES,
 PAGE_TEMPLATE_NAME,
 SITE_CONFIG_NAME,
 SITE_DATA_NAME,
 SITE_FOLDER_NAME,
 TEMP_FOLDER_NAME,
 TEMPLATE_SITE_ASSET_FOLDER_NAME,
 USER_VARIABLES_PATH,
 WIKI_SITE_NAV_PATH,
 WIKI_FOOTER_PATH,
} = require('./constants');
const CONFIG_FOLDER_NAME = '_markbind';
const SITE_FOLDER_NAME = '_site';
const TEMP_FOLDER_NAME = '.temp';
const TEMPLATE_SITE_ASSET_FOLDER_NAME = 'markbind';
const LAYOUT_SITE_FOLDER_NAME = 'layouts';

const ABOUT_MARKDOWN_FILE = 'about.md';
const FAVICON_DEFAULT_PATH = 'favicon.ico';
const USER_VARIABLES_PATH = '_markbind/variables.md';

const PAGE_TEMPLATE_NAME = 'page.njk';
const SITE_DATA_NAME = 'siteData.json';

const WIKI_SITE_NAV_PATH = '_Sidebar.md';
const WIKI_FOOTER_PATH = '_Footer.md';

const MAX_CONCURRENT_PAGE_GENERATION_PROMISES = 4;

const LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT = 30000;
const LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT = 5000;

function getBootswatchThemePath(theme) {
 return require.resolve(`bootswatch/dist/${theme}/bootstrap.min.css`);
Expand DownExpand Up@@ -104,6 +99,7 @@ const HIGHLIGHT_ASSETS = {
const ABOUT_MARKDOWN_DEFAULT = '# About\n'
 + 'Welcome to your **About Us** page.\n';

const MARKBIND_WEBSITE_URL = 'https://markbind.org/';
const MARKBIND_LINK_HTML = `<a href='${MARKBIND_WEBSITE_URL}'>MarkBind ${MARKBIND_VERSION}</a>`;

class Site {
Expand Down

12 changes: 0 additions & 12 deletions
packages/core/src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
module.exports = {
 // Page.js and Site.js
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',

 // packages/core/src/Parser.js
 ATTRIB_CWF: 'cwf',

 BOILERPLATE_FOLDER_NAME: '_markbind/boilerplates',

 // packages/core/src/plugins/algolia.js
 ALGOLIA_CSS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css',
 ALGOLIA_JS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js',
 ALGOLIA_INPUT_SELECTOR: '#algolia-search-input',
};

4 changes: 2 additions & 2 deletions
packages/core/src/html/NodeProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,12 +28,12 @@ const { createErrorNode } = require('./elements');
const fsUtil = require('../utils/fsUtil');
const logger = require('../utils/logger');

const { FRONT_MATTER_FENCE } = require('../Page/constants');

const {
 ATTRIB_CWF,
} = require('../constants');

const FRONT_MATTER_FENCE = '---';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

class NodeProcessor {
Expand Down

32 changes: 20 additions & 12 deletions
packages/core/src/html/siteAndPageNavProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,25 @@ const { v4: uuidv4 } = require('uuid');
const cheerio = require('cheerio'); require('../patches/htmlparser2');
const md = require('../lib/markdown-it');

const {
 SITE_NAV_EMPTY_LINE_REGEX,
 SITE_NAV_LIST_CLASS,
 SITE_NAV_LIST_CLASS_ROOT,
 SITE_NAV_LIST_ITEM_CLASS,
 SITE_NAV_DEFAULT_LIST_ITEM_CLASS,
 SITE_NAV_CUSTOM_LIST_ITEM_CLASS,
 SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX,
 SITE_NAV_DROPDOWN_ICON_ROTATED_HTML,
 SITE_NAV_DROPDOWN_ICON_HTML,
} = require('../Page/constants');
const SITE_NAV_ID = 'site-nav';
const SITE_NAV_EMPTY_LINE_REGEX = /\r?\n\s*\r?\n/g;

const SITE_NAV_LIST_ITEM_CLASS = 'site-nav-list-item';
const SITE_NAV_LIST_CLASS = 'site-nav-list';
const SITE_NAV_LIST_CLASS_ROOT = 'site-nav-list-root';

const SITE_NAV_DEFAULT_LIST_ITEM_CLASS = 'site-nav-default-list-item';
const SITE_NAV_CUSTOM_LIST_ITEM_CLASS = 'site-nav-custom-list-item';

const SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX = /:expanded:/g;
const SITE_NAV_DROPDOWN_ICON_HTML = '<i class="site-nav-dropdown-btn-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
const SITE_NAV_DROPDOWN_ICON_ROTATED_HTML = '<i class="site-nav-dropdown-btn-icon site-nav-rotate-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';

/**
 * Replaces and stores a uuid identifier to the only page-nav element, if there is one.
Expand DownExpand Up@@ -130,7 +138,7 @@ function addOverlayPortalSource(node, to) {
 * This component portals said element into the mobile navbar menus as needed.
 */
function addSitePageNavPortal(node) {
 if (node.attribs.id === 'site-nav' || node.attribs.id === 'page-nav') {
 if (node.attribs.id === SITE_NAV_ID || node.attribs.id === 'page-nav') {
 addOverlayPortalSource(node, node.attribs.id);
 } else if (node.attribs['mb-site-nav']) {
 addOverlayPortalSource(node, 'mb-site-nav');
Expand Down

8 changes: 3 additions & 5 deletions
packages/core/src/plugins/algolia.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
const cheerio = module.parent.require('cheerio');

const {
 ALGOLIA_CSS_URL,
 ALGOLIA_JS_URL,
 ALGOLIA_INPUT_SELECTOR,
} = require('../constants');
const ALGOLIA_CSS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css';
const ALGOLIA_JS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js';
const ALGOLIA_INPUT_SELECTOR = '#algolia-search-input';

function buildAlgoliaInitScript(pluginContext) {
 return `<script>
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/utils/urlUtil.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import path from 'path';
import pathIsInside from 'path-is-inside';

const {
 BOILERPLATE_FOLDER_NAME,
} = require('../constants');
const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

/**
 * Calculates the absolute path of of the immediate parent site of the specified filePath.
Expand Down

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

Skip to content
Reorganize constants in packages/core#1987

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

jonahtanjz
merged 1 commit into

from

Aug 11, 2022
 Merged


Reorganize constants in packages/core
#1987
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


2 changes: 1 addition & 1 deletion
packages/core/src/Layout/LayoutManager.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ const { Layout } = require('./Layout');

const logger = require('../utils/logger');

const { FRONT_MATTER_NONE_ATTR } = require('../Page/constants');
const FRONT_MATTER_NONE_ATTR = 'none';

class LayoutManager {
 constructor(config) {
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/Layout/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,6 @@ const { LayoutManager } = require('./LayoutManager');
module.exports = {
 Layout,
 LayoutManager,
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',
};

31 changes: 0 additions & 31 deletions
packages/core/src/Page/constants.js

View file


Open in desktop


This file was deleted.


26 changes: 13 additions & 13 deletions
packages/core/src/Page/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,16 +20,18 @@ const logger = require('../utils/logger');

const PACKAGE_VERSION = require('../../package.json').version;

const {
 PAGE_NAV_ID,
 PAGE_NAV_TITLE_CLASS,
 TITLE_PREFIX_SEPARATOR,
 TITLE_SUFFIX_SEPARATOR,
} = require('./constants');

const {
 LAYOUT_DEFAULT_NAME,
} = require('../constants');
} = require('../Layout');

const TITLE_PREFIX_SEPARATOR = ' - ';
const TITLE_SUFFIX_SEPARATOR = ' - ';

const PAGE_NAV_ID = 'mb-page-nav';
const PAGE_NAV_TITLE_CLASS = 'page-nav-title';

const SCROLL_TO_TOP_BUTTON_HTML = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" '
 + 'id="scroll-top-button" onclick="handleScrollTop()" aria-hidden="true"></i>';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

Expand DownExpand Up@@ -103,7 +105,7 @@ class Page {
 */

 /**
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter.}
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter}.
 * @type {string}
 */
 this.layout = this.pageConfig.layout;
Expand DownExpand Up@@ -435,7 +437,7 @@ class Page {
 portal-ing it into the mobile page nav.
 */
 return `${pageNavTitleHtml}\n`
+ `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="mb-page-nav"`
 + `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="${PAGE_NAV_ID}"`
 + ' class="nav nav-pills flex-column my-0 small no-flex-wrap">\n'
 + `${pageNavHeadingHTML}\n`
 + '</overlay-source>\n';
Expand DownExpand Up@@ -542,9 +544,7 @@ class Page {
 }

 static addScrollToTopButton(pageData) {
 const button = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" id="scroll-top-button" '
 + 'onclick="handleScrollTop()" aria-hidden="true"></i>';
 return `${pageData}\n${button}`;
 return `${pageData}\n${SCROLL_TO_TOP_BUTTON_HTML}`;
 }

 /**
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/Site/SiteConfig.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
const logger = require('../utils/logger');

const {
 HEADING_INDEXING_LEVEL_DEFAULT,
} = require('./constants');
const HEADING_INDEXING_LEVEL_DEFAULT = 3;

/**
 * Represents a read only site config read from the site configuration file,
Expand Down

18 changes: 0 additions & 18 deletions
packages/core/src/Site/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
module.exports = {
 CONFIG_FOLDER_NAME: '_markbind',
 HEADING_INDEXING_LEVEL_DEFAULT: 3,
 SITE_FOLDER_NAME: '_site',
 TEMP_FOLDER_NAME: '.temp',
 TEMPLATE_SITE_ASSET_FOLDER_NAME: 'markbind',

 ABOUT_MARKDOWN_FILE: 'about.md',
 FAVICON_DEFAULT_PATH: 'favicon.ico',
 INDEX_MARKDOWN_FILE: 'index.md',
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES: 4,
 PAGE_TEMPLATE_NAME: 'page.njk',
 SITE_CONFIG_NAME: 'site.json',
 SITE_DATA_NAME: 'siteData.json',
 LAYOUT_SITE_FOLDER_NAME: 'layouts',
 LAZY_LOADING_SITE_FILE_NAME: 'LazyLiveReloadLoadingSite.html',
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT: 30000,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT: 5000,
 USER_VARIABLES_PATH: '_markbind/variables.md',
 WIKI_SITE_NAV_PATH: '_Sidebar.md',
 WIKI_FOOTER_PATH: '_Footer.md',
 MARKBIND_WEBSITE_URL: 'https://markbind.org/',
};

50 changes: 23 additions & 27 deletions
packages/core/src/Site/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ const { PageConfig } = require('../Page/PageConfig');
const VariableProcessor = require('../variables/VariableProcessor');
const VariableRenderer = require('../variables/VariableRenderer');
const { ExternalManager } = require('../External/ExternalManager');
const { LayoutManager } = require('../Layout');
const { LayoutManager, LAYOUT_DEFAULT_NAME, LAYOUT_FOLDER_PATH } = require('../Layout');
const { SiteLinkManager } = require('../html/SiteLinkManager');
const { PluginManager } = require('../plugins/PluginManager');
const Template = require('../../template/template');
Expand All@@ -24,11 +24,7 @@ const { delay } = require('../utils/delay');
const fsUtil = require('../utils/fsUtil');
const gitUtil = require('../utils/git');
const logger = require('../utils/logger');

const {
 LAYOUT_DEFAULT_NAME,
 LAYOUT_FOLDER_PATH,
} = require('../constants');
const { SITE_CONFIG_NAME, INDEX_MARKDOWN_FILE, LAZY_LOADING_SITE_FILE_NAME } = require('./constants');

const _ = {};
_.difference = require('lodash/difference');
Expand All@@ -50,27 +46,26 @@ url.join = path.posix.join;

const MARKBIND_VERSION = require('../../package.json').version;

const {
 ABOUT_MARKDOWN_FILE,
 CONFIG_FOLDER_NAME,
 FAVICON_DEFAULT_PATH,
 INDEX_MARKDOWN_FILE,
 LAYOUT_SITE_FOLDER_NAME,
 LAZY_LOADING_SITE_FILE_NAME,
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT,
 MARKBIND_WEBSITE_URL,
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES,
 PAGE_TEMPLATE_NAME,
 SITE_CONFIG_NAME,
 SITE_DATA_NAME,
 SITE_FOLDER_NAME,
 TEMP_FOLDER_NAME,
 TEMPLATE_SITE_ASSET_FOLDER_NAME,
 USER_VARIABLES_PATH,
 WIKI_SITE_NAV_PATH,
 WIKI_FOOTER_PATH,
} = require('./constants');
const CONFIG_FOLDER_NAME = '_markbind';
const SITE_FOLDER_NAME = '_site';
const TEMP_FOLDER_NAME = '.temp';
const TEMPLATE_SITE_ASSET_FOLDER_NAME = 'markbind';
const LAYOUT_SITE_FOLDER_NAME = 'layouts';

const ABOUT_MARKDOWN_FILE = 'about.md';
const FAVICON_DEFAULT_PATH = 'favicon.ico';
const USER_VARIABLES_PATH = '_markbind/variables.md';

const PAGE_TEMPLATE_NAME = 'page.njk';
const SITE_DATA_NAME = 'siteData.json';

const WIKI_SITE_NAV_PATH = '_Sidebar.md';
const WIKI_FOOTER_PATH = '_Footer.md';

const MAX_CONCURRENT_PAGE_GENERATION_PROMISES = 4;

const LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT = 30000;
const LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT = 5000;

function getBootswatchThemePath(theme) {
 return require.resolve(`bootswatch/dist/${theme}/bootstrap.min.css`);
Expand DownExpand Up@@ -104,6 +99,7 @@ const HIGHLIGHT_ASSETS = {
const ABOUT_MARKDOWN_DEFAULT = '# About\n'
 + 'Welcome to your **About Us** page.\n';

const MARKBIND_WEBSITE_URL = 'https://markbind.org/';
const MARKBIND_LINK_HTML = `<a href='${MARKBIND_WEBSITE_URL}'>MarkBind ${MARKBIND_VERSION}</a>`;

class Site {
Expand Down

12 changes: 0 additions & 12 deletions
packages/core/src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
module.exports = {
 // Page.js and Site.js
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',

 // packages/core/src/Parser.js
 ATTRIB_CWF: 'cwf',

 BOILERPLATE_FOLDER_NAME: '_markbind/boilerplates',

 // packages/core/src/plugins/algolia.js
 ALGOLIA_CSS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css',
 ALGOLIA_JS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js',
 ALGOLIA_INPUT_SELECTOR: '#algolia-search-input',
};

4 changes: 2 additions & 2 deletions
packages/core/src/html/NodeProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,12 +28,12 @@ const { createErrorNode } = require('./elements');
const fsUtil = require('../utils/fsUtil');
const logger = require('../utils/logger');

const { FRONT_MATTER_FENCE } = require('../Page/constants');

const {
 ATTRIB_CWF,
} = require('../constants');

const FRONT_MATTER_FENCE = '---';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

class NodeProcessor {
Expand Down

32 changes: 20 additions & 12 deletions
packages/core/src/html/siteAndPageNavProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,25 @@ const { v4: uuidv4 } = require('uuid');
const cheerio = require('cheerio'); require('../patches/htmlparser2');
const md = require('../lib/markdown-it');

const {
 SITE_NAV_EMPTY_LINE_REGEX,
 SITE_NAV_LIST_CLASS,
 SITE_NAV_LIST_CLASS_ROOT,
 SITE_NAV_LIST_ITEM_CLASS,
 SITE_NAV_DEFAULT_LIST_ITEM_CLASS,
 SITE_NAV_CUSTOM_LIST_ITEM_CLASS,
 SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX,
 SITE_NAV_DROPDOWN_ICON_ROTATED_HTML,
 SITE_NAV_DROPDOWN_ICON_HTML,
} = require('../Page/constants');
const SITE_NAV_ID = 'site-nav';
const SITE_NAV_EMPTY_LINE_REGEX = /\r?\n\s*\r?\n/g;

const SITE_NAV_LIST_ITEM_CLASS = 'site-nav-list-item';
const SITE_NAV_LIST_CLASS = 'site-nav-list';
const SITE_NAV_LIST_CLASS_ROOT = 'site-nav-list-root';

const SITE_NAV_DEFAULT_LIST_ITEM_CLASS = 'site-nav-default-list-item';
const SITE_NAV_CUSTOM_LIST_ITEM_CLASS = 'site-nav-custom-list-item';

const SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX = /:expanded:/g;
const SITE_NAV_DROPDOWN_ICON_HTML = '<i class="site-nav-dropdown-btn-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
const SITE_NAV_DROPDOWN_ICON_ROTATED_HTML = '<i class="site-nav-dropdown-btn-icon site-nav-rotate-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';

/**
 * Replaces and stores a uuid identifier to the only page-nav element, if there is one.
Expand DownExpand Up@@ -130,7 +138,7 @@ function addOverlayPortalSource(node, to) {
 * This component portals said element into the mobile navbar menus as needed.
 */
function addSitePageNavPortal(node) {
 if (node.attribs.id === 'site-nav' || node.attribs.id === 'page-nav') {
 if (node.attribs.id === SITE_NAV_ID || node.attribs.id === 'page-nav') {
 addOverlayPortalSource(node, node.attribs.id);
 } else if (node.attribs['mb-site-nav']) {
 addOverlayPortalSource(node, 'mb-site-nav');
Expand Down

8 changes: 3 additions & 5 deletions
packages/core/src/plugins/algolia.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
const cheerio = module.parent.require('cheerio');

const {
 ALGOLIA_CSS_URL,
 ALGOLIA_JS_URL,
 ALGOLIA_INPUT_SELECTOR,
} = require('../constants');
const ALGOLIA_CSS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css';
const ALGOLIA_JS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js';
const ALGOLIA_INPUT_SELECTOR = '#algolia-search-input';

function buildAlgoliaInitScript(pluginContext) {
 return `<script>
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/utils/urlUtil.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import path from 'path';
import pathIsInside from 'path-is-inside';

const {
 BOILERPLATE_FOLDER_NAME,
} = require('../constants');
const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

/**
 * Calculates the absolute path of of the immediate parent site of the specified filePath.
Expand Down

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

Skip to content
Reorganize constants in packages/core#1987

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

jonahtanjz
merged 1 commit into

from

Aug 11, 2022
 Merged


Reorganize constants in packages/core
#1987
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


2 changes: 1 addition & 1 deletion
packages/core/src/Layout/LayoutManager.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ const { Layout } = require('./Layout');

const logger = require('../utils/logger');

const { FRONT_MATTER_NONE_ATTR } = require('../Page/constants');
const FRONT_MATTER_NONE_ATTR = 'none';

class LayoutManager {
 constructor(config) {
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/Layout/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,6 @@ const { LayoutManager } = require('./LayoutManager');
module.exports = {
 Layout,
 LayoutManager,
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',
};

31 changes: 0 additions & 31 deletions
packages/core/src/Page/constants.js

View file


Open in desktop


This file was deleted.


26 changes: 13 additions & 13 deletions
packages/core/src/Page/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,16 +20,18 @@ const logger = require('../utils/logger');

const PACKAGE_VERSION = require('../../package.json').version;

const {
 PAGE_NAV_ID,
 PAGE_NAV_TITLE_CLASS,
 TITLE_PREFIX_SEPARATOR,
 TITLE_SUFFIX_SEPARATOR,
} = require('./constants');

const {
 LAYOUT_DEFAULT_NAME,
} = require('../constants');
} = require('../Layout');

const TITLE_PREFIX_SEPARATOR = ' - ';
const TITLE_SUFFIX_SEPARATOR = ' - ';

const PAGE_NAV_ID = 'mb-page-nav';
const PAGE_NAV_TITLE_CLASS = 'page-nav-title';

const SCROLL_TO_TOP_BUTTON_HTML = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" '
 + 'id="scroll-top-button" onclick="handleScrollTop()" aria-hidden="true"></i>';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

Expand DownExpand Up@@ -103,7 +105,7 @@ class Page {
 */

 /**
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter.}
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter}.
 * @type {string}
 */
 this.layout = this.pageConfig.layout;
Expand DownExpand Up@@ -435,7 +437,7 @@ class Page {
 portal-ing it into the mobile page nav.
 */
 return `${pageNavTitleHtml}\n`
+ `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="mb-page-nav"`
 + `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="${PAGE_NAV_ID}"`
 + ' class="nav nav-pills flex-column my-0 small no-flex-wrap">\n'
 + `${pageNavHeadingHTML}\n`
 + '</overlay-source>\n';
Expand DownExpand Up@@ -542,9 +544,7 @@ class Page {
 }

 static addScrollToTopButton(pageData) {
 const button = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" id="scroll-top-button" '
 + 'onclick="handleScrollTop()" aria-hidden="true"></i>';
 return `${pageData}\n${button}`;
 return `${pageData}\n${SCROLL_TO_TOP_BUTTON_HTML}`;
 }

 /**
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/Site/SiteConfig.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
const logger = require('../utils/logger');

const {
 HEADING_INDEXING_LEVEL_DEFAULT,
} = require('./constants');
const HEADING_INDEXING_LEVEL_DEFAULT = 3;

/**
 * Represents a read only site config read from the site configuration file,
Expand Down

18 changes: 0 additions & 18 deletions
packages/core/src/Site/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
module.exports = {
 CONFIG_FOLDER_NAME: '_markbind',
 HEADING_INDEXING_LEVEL_DEFAULT: 3,
 SITE_FOLDER_NAME: '_site',
 TEMP_FOLDER_NAME: '.temp',
 TEMPLATE_SITE_ASSET_FOLDER_NAME: 'markbind',

 ABOUT_MARKDOWN_FILE: 'about.md',
 FAVICON_DEFAULT_PATH: 'favicon.ico',
 INDEX_MARKDOWN_FILE: 'index.md',
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES: 4,
 PAGE_TEMPLATE_NAME: 'page.njk',
 SITE_CONFIG_NAME: 'site.json',
 SITE_DATA_NAME: 'siteData.json',
 LAYOUT_SITE_FOLDER_NAME: 'layouts',
 LAZY_LOADING_SITE_FILE_NAME: 'LazyLiveReloadLoadingSite.html',
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT: 30000,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT: 5000,
 USER_VARIABLES_PATH: '_markbind/variables.md',
 WIKI_SITE_NAV_PATH: '_Sidebar.md',
 WIKI_FOOTER_PATH: '_Footer.md',
 MARKBIND_WEBSITE_URL: 'https://markbind.org/',
};

50 changes: 23 additions & 27 deletions
packages/core/src/Site/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ const { PageConfig } = require('../Page/PageConfig');
const VariableProcessor = require('../variables/VariableProcessor');
const VariableRenderer = require('../variables/VariableRenderer');
const { ExternalManager } = require('../External/ExternalManager');
const { LayoutManager } = require('../Layout');
const { LayoutManager, LAYOUT_DEFAULT_NAME, LAYOUT_FOLDER_PATH } = require('../Layout');
const { SiteLinkManager } = require('../html/SiteLinkManager');
const { PluginManager } = require('../plugins/PluginManager');
const Template = require('../../template/template');
Expand All@@ -24,11 +24,7 @@ const { delay } = require('../utils/delay');
const fsUtil = require('../utils/fsUtil');
const gitUtil = require('../utils/git');
const logger = require('../utils/logger');

const {
 LAYOUT_DEFAULT_NAME,
 LAYOUT_FOLDER_PATH,
} = require('../constants');
const { SITE_CONFIG_NAME, INDEX_MARKDOWN_FILE, LAZY_LOADING_SITE_FILE_NAME } = require('./constants');

const _ = {};
_.difference = require('lodash/difference');
Expand All@@ -50,27 +46,26 @@ url.join = path.posix.join;

const MARKBIND_VERSION = require('../../package.json').version;

const {
 ABOUT_MARKDOWN_FILE,
 CONFIG_FOLDER_NAME,
 FAVICON_DEFAULT_PATH,
 INDEX_MARKDOWN_FILE,
 LAYOUT_SITE_FOLDER_NAME,
 LAZY_LOADING_SITE_FILE_NAME,
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT,
 MARKBIND_WEBSITE_URL,
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES,
 PAGE_TEMPLATE_NAME,
 SITE_CONFIG_NAME,
 SITE_DATA_NAME,
 SITE_FOLDER_NAME,
 TEMP_FOLDER_NAME,
 TEMPLATE_SITE_ASSET_FOLDER_NAME,
 USER_VARIABLES_PATH,
 WIKI_SITE_NAV_PATH,
 WIKI_FOOTER_PATH,
} = require('./constants');
const CONFIG_FOLDER_NAME = '_markbind';
const SITE_FOLDER_NAME = '_site';
const TEMP_FOLDER_NAME = '.temp';
const TEMPLATE_SITE_ASSET_FOLDER_NAME = 'markbind';
const LAYOUT_SITE_FOLDER_NAME = 'layouts';

const ABOUT_MARKDOWN_FILE = 'about.md';
const FAVICON_DEFAULT_PATH = 'favicon.ico';
const USER_VARIABLES_PATH = '_markbind/variables.md';

const PAGE_TEMPLATE_NAME = 'page.njk';
const SITE_DATA_NAME = 'siteData.json';

const WIKI_SITE_NAV_PATH = '_Sidebar.md';
const WIKI_FOOTER_PATH = '_Footer.md';

const MAX_CONCURRENT_PAGE_GENERATION_PROMISES = 4;

const LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT = 30000;
const LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT = 5000;

function getBootswatchThemePath(theme) {
 return require.resolve(`bootswatch/dist/${theme}/bootstrap.min.css`);
Expand DownExpand Up@@ -104,6 +99,7 @@ const HIGHLIGHT_ASSETS = {
const ABOUT_MARKDOWN_DEFAULT = '# About\n'
 + 'Welcome to your **About Us** page.\n';

const MARKBIND_WEBSITE_URL = 'https://markbind.org/';
const MARKBIND_LINK_HTML = `<a href='${MARKBIND_WEBSITE_URL}'>MarkBind ${MARKBIND_VERSION}</a>`;

class Site {
Expand Down

12 changes: 0 additions & 12 deletions
packages/core/src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
module.exports = {
 // Page.js and Site.js
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',

 // packages/core/src/Parser.js
 ATTRIB_CWF: 'cwf',

 BOILERPLATE_FOLDER_NAME: '_markbind/boilerplates',

 // packages/core/src/plugins/algolia.js
 ALGOLIA_CSS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css',
 ALGOLIA_JS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js',
 ALGOLIA_INPUT_SELECTOR: '#algolia-search-input',
};

4 changes: 2 additions & 2 deletions
packages/core/src/html/NodeProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,12 +28,12 @@ const { createErrorNode } = require('./elements');
const fsUtil = require('../utils/fsUtil');
const logger = require('../utils/logger');

const { FRONT_MATTER_FENCE } = require('../Page/constants');

const {
 ATTRIB_CWF,
} = require('../constants');

const FRONT_MATTER_FENCE = '---';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

class NodeProcessor {
Expand Down

32 changes: 20 additions & 12 deletions
packages/core/src/html/siteAndPageNavProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,25 @@ const { v4: uuidv4 } = require('uuid');
const cheerio = require('cheerio'); require('../patches/htmlparser2');
const md = require('../lib/markdown-it');

const {
 SITE_NAV_EMPTY_LINE_REGEX,
 SITE_NAV_LIST_CLASS,
 SITE_NAV_LIST_CLASS_ROOT,
 SITE_NAV_LIST_ITEM_CLASS,
 SITE_NAV_DEFAULT_LIST_ITEM_CLASS,
 SITE_NAV_CUSTOM_LIST_ITEM_CLASS,
 SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX,
 SITE_NAV_DROPDOWN_ICON_ROTATED_HTML,
 SITE_NAV_DROPDOWN_ICON_HTML,
} = require('../Page/constants');
const SITE_NAV_ID = 'site-nav';
const SITE_NAV_EMPTY_LINE_REGEX = /\r?\n\s*\r?\n/g;

const SITE_NAV_LIST_ITEM_CLASS = 'site-nav-list-item';
const SITE_NAV_LIST_CLASS = 'site-nav-list';
const SITE_NAV_LIST_CLASS_ROOT = 'site-nav-list-root';

const SITE_NAV_DEFAULT_LIST_ITEM_CLASS = 'site-nav-default-list-item';
const SITE_NAV_CUSTOM_LIST_ITEM_CLASS = 'site-nav-custom-list-item';

const SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX = /:expanded:/g;
const SITE_NAV_DROPDOWN_ICON_HTML = '<i class="site-nav-dropdown-btn-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
const SITE_NAV_DROPDOWN_ICON_ROTATED_HTML = '<i class="site-nav-dropdown-btn-icon site-nav-rotate-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';

/**
 * Replaces and stores a uuid identifier to the only page-nav element, if there is one.
Expand DownExpand Up@@ -130,7 +138,7 @@ function addOverlayPortalSource(node, to) {
 * This component portals said element into the mobile navbar menus as needed.
 */
function addSitePageNavPortal(node) {
 if (node.attribs.id === 'site-nav' || node.attribs.id === 'page-nav') {
 if (node.attribs.id === SITE_NAV_ID || node.attribs.id === 'page-nav') {
 addOverlayPortalSource(node, node.attribs.id);
 } else if (node.attribs['mb-site-nav']) {
 addOverlayPortalSource(node, 'mb-site-nav');
Expand Down

8 changes: 3 additions & 5 deletions
packages/core/src/plugins/algolia.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
const cheerio = module.parent.require('cheerio');

const {
 ALGOLIA_CSS_URL,
 ALGOLIA_JS_URL,
 ALGOLIA_INPUT_SELECTOR,
} = require('../constants');
const ALGOLIA_CSS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css';
const ALGOLIA_JS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js';
const ALGOLIA_INPUT_SELECTOR = '#algolia-search-input';

function buildAlgoliaInitScript(pluginContext) {
 return `<script>
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/utils/urlUtil.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import path from 'path';
import pathIsInside from 'path-is-inside';

const {
 BOILERPLATE_FOLDER_NAME,
} = require('../constants');
const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

/**
 * Calculates the absolute path of of the immediate parent site of the specified filePath.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} 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
Reorganize constants in packages/core#1987

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

jonahtanjz
merged 1 commit into

from

Aug 11, 2022
 Merged


Reorganize constants in packages/core
#1987
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


2 changes: 1 addition & 1 deletion
packages/core/src/Layout/LayoutManager.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ const { Layout } = require('./Layout');

const logger = require('../utils/logger');

const { FRONT_MATTER_NONE_ATTR } = require('../Page/constants');
const FRONT_MATTER_NONE_ATTR = 'none';

class LayoutManager {
 constructor(config) {
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/Layout/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,6 @@ const { LayoutManager } = require('./LayoutManager');
module.exports = {
 Layout,
 LayoutManager,
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',
};

31 changes: 0 additions & 31 deletions
packages/core/src/Page/constants.js

View file


Open in desktop


This file was deleted.


26 changes: 13 additions & 13 deletions
packages/core/src/Page/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,16 +20,18 @@ const logger = require('../utils/logger');

const PACKAGE_VERSION = require('../../package.json').version;

const {
 PAGE_NAV_ID,
 PAGE_NAV_TITLE_CLASS,
 TITLE_PREFIX_SEPARATOR,
 TITLE_SUFFIX_SEPARATOR,
} = require('./constants');

const {
 LAYOUT_DEFAULT_NAME,
} = require('../constants');
} = require('../Layout');

const TITLE_PREFIX_SEPARATOR = ' - ';
const TITLE_SUFFIX_SEPARATOR = ' - ';

const PAGE_NAV_ID = 'mb-page-nav';
const PAGE_NAV_TITLE_CLASS = 'page-nav-title';

const SCROLL_TO_TOP_BUTTON_HTML = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" '
 + 'id="scroll-top-button" onclick="handleScrollTop()" aria-hidden="true"></i>';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

Expand DownExpand Up@@ -103,7 +105,7 @@ class Page {
 */

 /**
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter.}
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter}.
 * @type {string}
 */
 this.layout = this.pageConfig.layout;
Expand DownExpand Up@@ -435,7 +437,7 @@ class Page {
 portal-ing it into the mobile page nav.
 */
 return `${pageNavTitleHtml}\n`
+ `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="mb-page-nav"`
 + `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="${PAGE_NAV_ID}"`
 + ' class="nav nav-pills flex-column my-0 small no-flex-wrap">\n'
 + `${pageNavHeadingHTML}\n`
 + '</overlay-source>\n';
Expand DownExpand Up@@ -542,9 +544,7 @@ class Page {
 }

 static addScrollToTopButton(pageData) {
 const button = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" id="scroll-top-button" '
 + 'onclick="handleScrollTop()" aria-hidden="true"></i>';
 return `${pageData}\n${button}`;
 return `${pageData}\n${SCROLL_TO_TOP_BUTTON_HTML}`;
 }

 /**
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/Site/SiteConfig.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
const logger = require('../utils/logger');

const {
 HEADING_INDEXING_LEVEL_DEFAULT,
} = require('./constants');
const HEADING_INDEXING_LEVEL_DEFAULT = 3;

/**
 * Represents a read only site config read from the site configuration file,
Expand Down

18 changes: 0 additions & 18 deletions
packages/core/src/Site/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
module.exports = {
 CONFIG_FOLDER_NAME: '_markbind',
 HEADING_INDEXING_LEVEL_DEFAULT: 3,
 SITE_FOLDER_NAME: '_site',
 TEMP_FOLDER_NAME: '.temp',
 TEMPLATE_SITE_ASSET_FOLDER_NAME: 'markbind',

 ABOUT_MARKDOWN_FILE: 'about.md',
 FAVICON_DEFAULT_PATH: 'favicon.ico',
 INDEX_MARKDOWN_FILE: 'index.md',
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES: 4,
 PAGE_TEMPLATE_NAME: 'page.njk',
 SITE_CONFIG_NAME: 'site.json',
 SITE_DATA_NAME: 'siteData.json',
 LAYOUT_SITE_FOLDER_NAME: 'layouts',
 LAZY_LOADING_SITE_FILE_NAME: 'LazyLiveReloadLoadingSite.html',
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT: 30000,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT: 5000,
 USER_VARIABLES_PATH: '_markbind/variables.md',
 WIKI_SITE_NAV_PATH: '_Sidebar.md',
 WIKI_FOOTER_PATH: '_Footer.md',
 MARKBIND_WEBSITE_URL: 'https://markbind.org/',
};

50 changes: 23 additions & 27 deletions
packages/core/src/Site/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ const { PageConfig } = require('../Page/PageConfig');
const VariableProcessor = require('../variables/VariableProcessor');
const VariableRenderer = require('../variables/VariableRenderer');
const { ExternalManager } = require('../External/ExternalManager');
const { LayoutManager } = require('../Layout');
const { LayoutManager, LAYOUT_DEFAULT_NAME, LAYOUT_FOLDER_PATH } = require('../Layout');
const { SiteLinkManager } = require('../html/SiteLinkManager');
const { PluginManager } = require('../plugins/PluginManager');
const Template = require('../../template/template');
Expand All@@ -24,11 +24,7 @@ const { delay } = require('../utils/delay');
const fsUtil = require('../utils/fsUtil');
const gitUtil = require('../utils/git');
const logger = require('../utils/logger');

const {
 LAYOUT_DEFAULT_NAME,
 LAYOUT_FOLDER_PATH,
} = require('../constants');
const { SITE_CONFIG_NAME, INDEX_MARKDOWN_FILE, LAZY_LOADING_SITE_FILE_NAME } = require('./constants');

const _ = {};
_.difference = require('lodash/difference');
Expand All@@ -50,27 +46,26 @@ url.join = path.posix.join;

const MARKBIND_VERSION = require('../../package.json').version;

const {
 ABOUT_MARKDOWN_FILE,
 CONFIG_FOLDER_NAME,
 FAVICON_DEFAULT_PATH,
 INDEX_MARKDOWN_FILE,
 LAYOUT_SITE_FOLDER_NAME,
 LAZY_LOADING_SITE_FILE_NAME,
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT,
 MARKBIND_WEBSITE_URL,
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES,
 PAGE_TEMPLATE_NAME,
 SITE_CONFIG_NAME,
 SITE_DATA_NAME,
 SITE_FOLDER_NAME,
 TEMP_FOLDER_NAME,
 TEMPLATE_SITE_ASSET_FOLDER_NAME,
 USER_VARIABLES_PATH,
 WIKI_SITE_NAV_PATH,
 WIKI_FOOTER_PATH,
} = require('./constants');
const CONFIG_FOLDER_NAME = '_markbind';
const SITE_FOLDER_NAME = '_site';
const TEMP_FOLDER_NAME = '.temp';
const TEMPLATE_SITE_ASSET_FOLDER_NAME = 'markbind';
const LAYOUT_SITE_FOLDER_NAME = 'layouts';

const ABOUT_MARKDOWN_FILE = 'about.md';
const FAVICON_DEFAULT_PATH = 'favicon.ico';
const USER_VARIABLES_PATH = '_markbind/variables.md';

const PAGE_TEMPLATE_NAME = 'page.njk';
const SITE_DATA_NAME = 'siteData.json';

const WIKI_SITE_NAV_PATH = '_Sidebar.md';
const WIKI_FOOTER_PATH = '_Footer.md';

const MAX_CONCURRENT_PAGE_GENERATION_PROMISES = 4;

const LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT = 30000;
const LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT = 5000;

function getBootswatchThemePath(theme) {
 return require.resolve(`bootswatch/dist/${theme}/bootstrap.min.css`);
Expand DownExpand Up@@ -104,6 +99,7 @@ const HIGHLIGHT_ASSETS = {
const ABOUT_MARKDOWN_DEFAULT = '# About\n'
 + 'Welcome to your **About Us** page.\n';

const MARKBIND_WEBSITE_URL = 'https://markbind.org/';
const MARKBIND_LINK_HTML = `<a href='${MARKBIND_WEBSITE_URL}'>MarkBind ${MARKBIND_VERSION}</a>`;

class Site {
Expand Down

12 changes: 0 additions & 12 deletions
packages/core/src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
module.exports = {
 // Page.js and Site.js
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',

 // packages/core/src/Parser.js
 ATTRIB_CWF: 'cwf',

 BOILERPLATE_FOLDER_NAME: '_markbind/boilerplates',

 // packages/core/src/plugins/algolia.js
 ALGOLIA_CSS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css',
 ALGOLIA_JS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js',
 ALGOLIA_INPUT_SELECTOR: '#algolia-search-input',
};

4 changes: 2 additions & 2 deletions
packages/core/src/html/NodeProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,12 +28,12 @@ const { createErrorNode } = require('./elements');
const fsUtil = require('../utils/fsUtil');
const logger = require('../utils/logger');

const { FRONT_MATTER_FENCE } = require('../Page/constants');

const {
 ATTRIB_CWF,
} = require('../constants');

const FRONT_MATTER_FENCE = '---';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

class NodeProcessor {
Expand Down

32 changes: 20 additions & 12 deletions
packages/core/src/html/siteAndPageNavProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,25 @@ const { v4: uuidv4 } = require('uuid');
const cheerio = require('cheerio'); require('../patches/htmlparser2');
const md = require('../lib/markdown-it');

const {
 SITE_NAV_EMPTY_LINE_REGEX,
 SITE_NAV_LIST_CLASS,
 SITE_NAV_LIST_CLASS_ROOT,
 SITE_NAV_LIST_ITEM_CLASS,
 SITE_NAV_DEFAULT_LIST_ITEM_CLASS,
 SITE_NAV_CUSTOM_LIST_ITEM_CLASS,
 SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX,
 SITE_NAV_DROPDOWN_ICON_ROTATED_HTML,
 SITE_NAV_DROPDOWN_ICON_HTML,
} = require('../Page/constants');
const SITE_NAV_ID = 'site-nav';
const SITE_NAV_EMPTY_LINE_REGEX = /\r?\n\s*\r?\n/g;

const SITE_NAV_LIST_ITEM_CLASS = 'site-nav-list-item';
const SITE_NAV_LIST_CLASS = 'site-nav-list';
const SITE_NAV_LIST_CLASS_ROOT = 'site-nav-list-root';

const SITE_NAV_DEFAULT_LIST_ITEM_CLASS = 'site-nav-default-list-item';
const SITE_NAV_CUSTOM_LIST_ITEM_CLASS = 'site-nav-custom-list-item';

const SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX = /:expanded:/g;
const SITE_NAV_DROPDOWN_ICON_HTML = '<i class="site-nav-dropdown-btn-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
const SITE_NAV_DROPDOWN_ICON_ROTATED_HTML = '<i class="site-nav-dropdown-btn-icon site-nav-rotate-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';

/**
 * Replaces and stores a uuid identifier to the only page-nav element, if there is one.
Expand DownExpand Up@@ -130,7 +138,7 @@ function addOverlayPortalSource(node, to) {
 * This component portals said element into the mobile navbar menus as needed.
 */
function addSitePageNavPortal(node) {
 if (node.attribs.id === 'site-nav' || node.attribs.id === 'page-nav') {
 if (node.attribs.id === SITE_NAV_ID || node.attribs.id === 'page-nav') {
 addOverlayPortalSource(node, node.attribs.id);
 } else if (node.attribs['mb-site-nav']) {
 addOverlayPortalSource(node, 'mb-site-nav');
Expand Down

8 changes: 3 additions & 5 deletions
packages/core/src/plugins/algolia.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
const cheerio = module.parent.require('cheerio');

const {
 ALGOLIA_CSS_URL,
 ALGOLIA_JS_URL,
 ALGOLIA_INPUT_SELECTOR,
} = require('../constants');
const ALGOLIA_CSS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css';
const ALGOLIA_JS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js';
const ALGOLIA_INPUT_SELECTOR = '#algolia-search-input';

function buildAlgoliaInitScript(pluginContext) {
 return `<script>
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/utils/urlUtil.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import path from 'path';
import pathIsInside from 'path-is-inside';

const {
 BOILERPLATE_FOLDER_NAME,
} = require('../constants');
const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

/**
 * Calculates the absolute path of of the immediate parent site of the specified filePath.
Expand Down

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

Skip to content
Reorganize constants in packages/core#1987

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

jonahtanjz
merged 1 commit into

from

Aug 11, 2022
 Merged


Reorganize constants in packages/core
#1987
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


2 changes: 1 addition & 1 deletion
packages/core/src/Layout/LayoutManager.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ const { Layout } = require('./Layout');

const logger = require('../utils/logger');

const { FRONT_MATTER_NONE_ATTR } = require('../Page/constants');
const FRONT_MATTER_NONE_ATTR = 'none';

class LayoutManager {
 constructor(config) {
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/Layout/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,6 @@ const { LayoutManager } = require('./LayoutManager');
module.exports = {
 Layout,
 LayoutManager,
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',
};

31 changes: 0 additions & 31 deletions
packages/core/src/Page/constants.js

View file


Open in desktop


This file was deleted.


26 changes: 13 additions & 13 deletions
packages/core/src/Page/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,16 +20,18 @@ const logger = require('../utils/logger');

const PACKAGE_VERSION = require('../../package.json').version;

const {
 PAGE_NAV_ID,
 PAGE_NAV_TITLE_CLASS,
 TITLE_PREFIX_SEPARATOR,
 TITLE_SUFFIX_SEPARATOR,
} = require('./constants');

const {
 LAYOUT_DEFAULT_NAME,
} = require('../constants');
} = require('../Layout');

const TITLE_PREFIX_SEPARATOR = ' - ';
const TITLE_SUFFIX_SEPARATOR = ' - ';

const PAGE_NAV_ID = 'mb-page-nav';
const PAGE_NAV_TITLE_CLASS = 'page-nav-title';

const SCROLL_TO_TOP_BUTTON_HTML = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" '
 + 'id="scroll-top-button" onclick="handleScrollTop()" aria-hidden="true"></i>';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

Expand DownExpand Up@@ -103,7 +105,7 @@ class Page {
 */

 /**
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter.}
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter}.
 * @type {string}
 */
 this.layout = this.pageConfig.layout;
Expand DownExpand Up@@ -435,7 +437,7 @@ class Page {
 portal-ing it into the mobile page nav.
 */
 return `${pageNavTitleHtml}\n`
+ `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="mb-page-nav"`
 + `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="${PAGE_NAV_ID}"`
 + ' class="nav nav-pills flex-column my-0 small no-flex-wrap">\n'
 + `${pageNavHeadingHTML}\n`
 + '</overlay-source>\n';
Expand DownExpand Up@@ -542,9 +544,7 @@ class Page {
 }

 static addScrollToTopButton(pageData) {
 const button = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" id="scroll-top-button" '
 + 'onclick="handleScrollTop()" aria-hidden="true"></i>';
 return `${pageData}\n${button}`;
 return `${pageData}\n${SCROLL_TO_TOP_BUTTON_HTML}`;
 }

 /**
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/Site/SiteConfig.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
const logger = require('../utils/logger');

const {
 HEADING_INDEXING_LEVEL_DEFAULT,
} = require('./constants');
const HEADING_INDEXING_LEVEL_DEFAULT = 3;

/**
 * Represents a read only site config read from the site configuration file,
Expand Down

18 changes: 0 additions & 18 deletions
packages/core/src/Site/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
module.exports = {
 CONFIG_FOLDER_NAME: '_markbind',
 HEADING_INDEXING_LEVEL_DEFAULT: 3,
 SITE_FOLDER_NAME: '_site',
 TEMP_FOLDER_NAME: '.temp',
 TEMPLATE_SITE_ASSET_FOLDER_NAME: 'markbind',

 ABOUT_MARKDOWN_FILE: 'about.md',
 FAVICON_DEFAULT_PATH: 'favicon.ico',
 INDEX_MARKDOWN_FILE: 'index.md',
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES: 4,
 PAGE_TEMPLATE_NAME: 'page.njk',
 SITE_CONFIG_NAME: 'site.json',
 SITE_DATA_NAME: 'siteData.json',
 LAYOUT_SITE_FOLDER_NAME: 'layouts',
 LAZY_LOADING_SITE_FILE_NAME: 'LazyLiveReloadLoadingSite.html',
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT: 30000,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT: 5000,
 USER_VARIABLES_PATH: '_markbind/variables.md',
 WIKI_SITE_NAV_PATH: '_Sidebar.md',
 WIKI_FOOTER_PATH: '_Footer.md',
 MARKBIND_WEBSITE_URL: 'https://markbind.org/',
};

50 changes: 23 additions & 27 deletions
packages/core/src/Site/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ const { PageConfig } = require('../Page/PageConfig');
const VariableProcessor = require('../variables/VariableProcessor');
const VariableRenderer = require('../variables/VariableRenderer');
const { ExternalManager } = require('../External/ExternalManager');
const { LayoutManager } = require('../Layout');
const { LayoutManager, LAYOUT_DEFAULT_NAME, LAYOUT_FOLDER_PATH } = require('../Layout');
const { SiteLinkManager } = require('../html/SiteLinkManager');
const { PluginManager } = require('../plugins/PluginManager');
const Template = require('../../template/template');
Expand All@@ -24,11 +24,7 @@ const { delay } = require('../utils/delay');
const fsUtil = require('../utils/fsUtil');
const gitUtil = require('../utils/git');
const logger = require('../utils/logger');

const {
 LAYOUT_DEFAULT_NAME,
 LAYOUT_FOLDER_PATH,
} = require('../constants');
const { SITE_CONFIG_NAME, INDEX_MARKDOWN_FILE, LAZY_LOADING_SITE_FILE_NAME } = require('./constants');

const _ = {};
_.difference = require('lodash/difference');
Expand All@@ -50,27 +46,26 @@ url.join = path.posix.join;

const MARKBIND_VERSION = require('../../package.json').version;

const {
 ABOUT_MARKDOWN_FILE,
 CONFIG_FOLDER_NAME,
 FAVICON_DEFAULT_PATH,
 INDEX_MARKDOWN_FILE,
 LAYOUT_SITE_FOLDER_NAME,
 LAZY_LOADING_SITE_FILE_NAME,
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT,
 MARKBIND_WEBSITE_URL,
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES,
 PAGE_TEMPLATE_NAME,
 SITE_CONFIG_NAME,
 SITE_DATA_NAME,
 SITE_FOLDER_NAME,
 TEMP_FOLDER_NAME,
 TEMPLATE_SITE_ASSET_FOLDER_NAME,
 USER_VARIABLES_PATH,
 WIKI_SITE_NAV_PATH,
 WIKI_FOOTER_PATH,
} = require('./constants');
const CONFIG_FOLDER_NAME = '_markbind';
const SITE_FOLDER_NAME = '_site';
const TEMP_FOLDER_NAME = '.temp';
const TEMPLATE_SITE_ASSET_FOLDER_NAME = 'markbind';
const LAYOUT_SITE_FOLDER_NAME = 'layouts';

const ABOUT_MARKDOWN_FILE = 'about.md';
const FAVICON_DEFAULT_PATH = 'favicon.ico';
const USER_VARIABLES_PATH = '_markbind/variables.md';

const PAGE_TEMPLATE_NAME = 'page.njk';
const SITE_DATA_NAME = 'siteData.json';

const WIKI_SITE_NAV_PATH = '_Sidebar.md';
const WIKI_FOOTER_PATH = '_Footer.md';

const MAX_CONCURRENT_PAGE_GENERATION_PROMISES = 4;

const LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT = 30000;
const LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT = 5000;

function getBootswatchThemePath(theme) {
 return require.resolve(`bootswatch/dist/${theme}/bootstrap.min.css`);
Expand DownExpand Up@@ -104,6 +99,7 @@ const HIGHLIGHT_ASSETS = {
const ABOUT_MARKDOWN_DEFAULT = '# About\n'
 + 'Welcome to your **About Us** page.\n';

const MARKBIND_WEBSITE_URL = 'https://markbind.org/';
const MARKBIND_LINK_HTML = `<a href='${MARKBIND_WEBSITE_URL}'>MarkBind ${MARKBIND_VERSION}</a>`;

class Site {
Expand Down

12 changes: 0 additions & 12 deletions
packages/core/src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
module.exports = {
 // Page.js and Site.js
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',

 // packages/core/src/Parser.js
 ATTRIB_CWF: 'cwf',

 BOILERPLATE_FOLDER_NAME: '_markbind/boilerplates',

 // packages/core/src/plugins/algolia.js
 ALGOLIA_CSS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css',
 ALGOLIA_JS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js',
 ALGOLIA_INPUT_SELECTOR: '#algolia-search-input',
};

4 changes: 2 additions & 2 deletions
packages/core/src/html/NodeProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,12 +28,12 @@ const { createErrorNode } = require('./elements');
const fsUtil = require('../utils/fsUtil');
const logger = require('../utils/logger');

const { FRONT_MATTER_FENCE } = require('../Page/constants');

const {
 ATTRIB_CWF,
} = require('../constants');

const FRONT_MATTER_FENCE = '---';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

class NodeProcessor {
Expand Down

32 changes: 20 additions & 12 deletions
packages/core/src/html/siteAndPageNavProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,25 @@ const { v4: uuidv4 } = require('uuid');
const cheerio = require('cheerio'); require('../patches/htmlparser2');
const md = require('../lib/markdown-it');

const {
 SITE_NAV_EMPTY_LINE_REGEX,
 SITE_NAV_LIST_CLASS,
 SITE_NAV_LIST_CLASS_ROOT,
 SITE_NAV_LIST_ITEM_CLASS,
 SITE_NAV_DEFAULT_LIST_ITEM_CLASS,
 SITE_NAV_CUSTOM_LIST_ITEM_CLASS,
 SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX,
 SITE_NAV_DROPDOWN_ICON_ROTATED_HTML,
 SITE_NAV_DROPDOWN_ICON_HTML,
} = require('../Page/constants');
const SITE_NAV_ID = 'site-nav';
const SITE_NAV_EMPTY_LINE_REGEX = /\r?\n\s*\r?\n/g;

const SITE_NAV_LIST_ITEM_CLASS = 'site-nav-list-item';
const SITE_NAV_LIST_CLASS = 'site-nav-list';
const SITE_NAV_LIST_CLASS_ROOT = 'site-nav-list-root';

const SITE_NAV_DEFAULT_LIST_ITEM_CLASS = 'site-nav-default-list-item';
const SITE_NAV_CUSTOM_LIST_ITEM_CLASS = 'site-nav-custom-list-item';

const SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX = /:expanded:/g;
const SITE_NAV_DROPDOWN_ICON_HTML = '<i class="site-nav-dropdown-btn-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
const SITE_NAV_DROPDOWN_ICON_ROTATED_HTML = '<i class="site-nav-dropdown-btn-icon site-nav-rotate-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';

/**
 * Replaces and stores a uuid identifier to the only page-nav element, if there is one.
Expand DownExpand Up@@ -130,7 +138,7 @@ function addOverlayPortalSource(node, to) {
 * This component portals said element into the mobile navbar menus as needed.
 */
function addSitePageNavPortal(node) {
 if (node.attribs.id === 'site-nav' || node.attribs.id === 'page-nav') {
 if (node.attribs.id === SITE_NAV_ID || node.attribs.id === 'page-nav') {
 addOverlayPortalSource(node, node.attribs.id);
 } else if (node.attribs['mb-site-nav']) {
 addOverlayPortalSource(node, 'mb-site-nav');
Expand Down

8 changes: 3 additions & 5 deletions
packages/core/src/plugins/algolia.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
const cheerio = module.parent.require('cheerio');

const {
 ALGOLIA_CSS_URL,
 ALGOLIA_JS_URL,
 ALGOLIA_INPUT_SELECTOR,
} = require('../constants');
const ALGOLIA_CSS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css';
const ALGOLIA_JS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js';
const ALGOLIA_INPUT_SELECTOR = '#algolia-search-input';

function buildAlgoliaInitScript(pluginContext) {
 return `<script>
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/utils/urlUtil.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import path from 'path';
import pathIsInside from 'path-is-inside';

const {
 BOILERPLATE_FOLDER_NAME,
} = require('../constants');
const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

/**
 * Calculates the absolute path of of the immediate parent site of the specified filePath.
Expand Down

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

Skip to content
Reorganize constants in packages/core#1987

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

jonahtanjz
merged 1 commit into

from

Aug 11, 2022
 Merged


Reorganize constants in packages/core
#1987
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


2 changes: 1 addition & 1 deletion
packages/core/src/Layout/LayoutManager.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ const { Layout } = require('./Layout');

const logger = require('../utils/logger');

const { FRONT_MATTER_NONE_ATTR } = require('../Page/constants');
const FRONT_MATTER_NONE_ATTR = 'none';

class LayoutManager {
 constructor(config) {
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/Layout/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,6 @@ const { LayoutManager } = require('./LayoutManager');
module.exports = {
 Layout,
 LayoutManager,
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',
};

31 changes: 0 additions & 31 deletions
packages/core/src/Page/constants.js

View file


Open in desktop


This file was deleted.


26 changes: 13 additions & 13 deletions
packages/core/src/Page/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,16 +20,18 @@ const logger = require('../utils/logger');

const PACKAGE_VERSION = require('../../package.json').version;

const {
 PAGE_NAV_ID,
 PAGE_NAV_TITLE_CLASS,
 TITLE_PREFIX_SEPARATOR,
 TITLE_SUFFIX_SEPARATOR,
} = require('./constants');

const {
 LAYOUT_DEFAULT_NAME,
} = require('../constants');
} = require('../Layout');

const TITLE_PREFIX_SEPARATOR = ' - ';
const TITLE_SUFFIX_SEPARATOR = ' - ';

const PAGE_NAV_ID = 'mb-page-nav';
const PAGE_NAV_TITLE_CLASS = 'page-nav-title';

const SCROLL_TO_TOP_BUTTON_HTML = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" '
 + 'id="scroll-top-button" onclick="handleScrollTop()" aria-hidden="true"></i>';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

Expand DownExpand Up@@ -103,7 +105,7 @@ class Page {
 */

 /**
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter.}
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter}.
 * @type {string}
 */
 this.layout = this.pageConfig.layout;
Expand DownExpand Up@@ -435,7 +437,7 @@ class Page {
 portal-ing it into the mobile page nav.
 */
 return `${pageNavTitleHtml}\n`
+ `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="mb-page-nav"`
 + `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="${PAGE_NAV_ID}"`
 + ' class="nav nav-pills flex-column my-0 small no-flex-wrap">\n'
 + `${pageNavHeadingHTML}\n`
 + '</overlay-source>\n';
Expand DownExpand Up@@ -542,9 +544,7 @@ class Page {
 }

 static addScrollToTopButton(pageData) {
 const button = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" id="scroll-top-button" '
 + 'onclick="handleScrollTop()" aria-hidden="true"></i>';
 return `${pageData}\n${button}`;
 return `${pageData}\n${SCROLL_TO_TOP_BUTTON_HTML}`;
 }

 /**
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/Site/SiteConfig.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
const logger = require('../utils/logger');

const {
 HEADING_INDEXING_LEVEL_DEFAULT,
} = require('./constants');
const HEADING_INDEXING_LEVEL_DEFAULT = 3;

/**
 * Represents a read only site config read from the site configuration file,
Expand Down

18 changes: 0 additions & 18 deletions
packages/core/src/Site/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
module.exports = {
 CONFIG_FOLDER_NAME: '_markbind',
 HEADING_INDEXING_LEVEL_DEFAULT: 3,
 SITE_FOLDER_NAME: '_site',
 TEMP_FOLDER_NAME: '.temp',
 TEMPLATE_SITE_ASSET_FOLDER_NAME: 'markbind',

 ABOUT_MARKDOWN_FILE: 'about.md',
 FAVICON_DEFAULT_PATH: 'favicon.ico',
 INDEX_MARKDOWN_FILE: 'index.md',
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES: 4,
 PAGE_TEMPLATE_NAME: 'page.njk',
 SITE_CONFIG_NAME: 'site.json',
 SITE_DATA_NAME: 'siteData.json',
 LAYOUT_SITE_FOLDER_NAME: 'layouts',
 LAZY_LOADING_SITE_FILE_NAME: 'LazyLiveReloadLoadingSite.html',
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT: 30000,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT: 5000,
 USER_VARIABLES_PATH: '_markbind/variables.md',
 WIKI_SITE_NAV_PATH: '_Sidebar.md',
 WIKI_FOOTER_PATH: '_Footer.md',
 MARKBIND_WEBSITE_URL: 'https://markbind.org/',
};

50 changes: 23 additions & 27 deletions
packages/core/src/Site/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ const { PageConfig } = require('../Page/PageConfig');
const VariableProcessor = require('../variables/VariableProcessor');
const VariableRenderer = require('../variables/VariableRenderer');
const { ExternalManager } = require('../External/ExternalManager');
const { LayoutManager } = require('../Layout');
const { LayoutManager, LAYOUT_DEFAULT_NAME, LAYOUT_FOLDER_PATH } = require('../Layout');
const { SiteLinkManager } = require('../html/SiteLinkManager');
const { PluginManager } = require('../plugins/PluginManager');
const Template = require('../../template/template');
Expand All@@ -24,11 +24,7 @@ const { delay } = require('../utils/delay');
const fsUtil = require('../utils/fsUtil');
const gitUtil = require('../utils/git');
const logger = require('../utils/logger');

const {
 LAYOUT_DEFAULT_NAME,
 LAYOUT_FOLDER_PATH,
} = require('../constants');
const { SITE_CONFIG_NAME, INDEX_MARKDOWN_FILE, LAZY_LOADING_SITE_FILE_NAME } = require('./constants');

const _ = {};
_.difference = require('lodash/difference');
Expand All@@ -50,27 +46,26 @@ url.join = path.posix.join;

const MARKBIND_VERSION = require('../../package.json').version;

const {
 ABOUT_MARKDOWN_FILE,
 CONFIG_FOLDER_NAME,
 FAVICON_DEFAULT_PATH,
 INDEX_MARKDOWN_FILE,
 LAYOUT_SITE_FOLDER_NAME,
 LAZY_LOADING_SITE_FILE_NAME,
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT,
 MARKBIND_WEBSITE_URL,
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES,
 PAGE_TEMPLATE_NAME,
 SITE_CONFIG_NAME,
 SITE_DATA_NAME,
 SITE_FOLDER_NAME,
 TEMP_FOLDER_NAME,
 TEMPLATE_SITE_ASSET_FOLDER_NAME,
 USER_VARIABLES_PATH,
 WIKI_SITE_NAV_PATH,
 WIKI_FOOTER_PATH,
} = require('./constants');
const CONFIG_FOLDER_NAME = '_markbind';
const SITE_FOLDER_NAME = '_site';
const TEMP_FOLDER_NAME = '.temp';
const TEMPLATE_SITE_ASSET_FOLDER_NAME = 'markbind';
const LAYOUT_SITE_FOLDER_NAME = 'layouts';

const ABOUT_MARKDOWN_FILE = 'about.md';
const FAVICON_DEFAULT_PATH = 'favicon.ico';
const USER_VARIABLES_PATH = '_markbind/variables.md';

const PAGE_TEMPLATE_NAME = 'page.njk';
const SITE_DATA_NAME = 'siteData.json';

const WIKI_SITE_NAV_PATH = '_Sidebar.md';
const WIKI_FOOTER_PATH = '_Footer.md';

const MAX_CONCURRENT_PAGE_GENERATION_PROMISES = 4;

const LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT = 30000;
const LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT = 5000;

function getBootswatchThemePath(theme) {
 return require.resolve(`bootswatch/dist/${theme}/bootstrap.min.css`);
Expand DownExpand Up@@ -104,6 +99,7 @@ const HIGHLIGHT_ASSETS = {
const ABOUT_MARKDOWN_DEFAULT = '# About\n'
 + 'Welcome to your **About Us** page.\n';

const MARKBIND_WEBSITE_URL = 'https://markbind.org/';
const MARKBIND_LINK_HTML = `<a href='${MARKBIND_WEBSITE_URL}'>MarkBind ${MARKBIND_VERSION}</a>`;

class Site {
Expand Down

12 changes: 0 additions & 12 deletions
packages/core/src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
module.exports = {
 // Page.js and Site.js
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',

 // packages/core/src/Parser.js
 ATTRIB_CWF: 'cwf',

 BOILERPLATE_FOLDER_NAME: '_markbind/boilerplates',

 // packages/core/src/plugins/algolia.js
 ALGOLIA_CSS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css',
 ALGOLIA_JS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js',
 ALGOLIA_INPUT_SELECTOR: '#algolia-search-input',
};

4 changes: 2 additions & 2 deletions
packages/core/src/html/NodeProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,12 +28,12 @@ const { createErrorNode } = require('./elements');
const fsUtil = require('../utils/fsUtil');
const logger = require('../utils/logger');

const { FRONT_MATTER_FENCE } = require('../Page/constants');

const {
 ATTRIB_CWF,
} = require('../constants');

const FRONT_MATTER_FENCE = '---';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

class NodeProcessor {
Expand Down

32 changes: 20 additions & 12 deletions
packages/core/src/html/siteAndPageNavProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,25 @@ const { v4: uuidv4 } = require('uuid');
const cheerio = require('cheerio'); require('../patches/htmlparser2');
const md = require('../lib/markdown-it');

const {
 SITE_NAV_EMPTY_LINE_REGEX,
 SITE_NAV_LIST_CLASS,
 SITE_NAV_LIST_CLASS_ROOT,
 SITE_NAV_LIST_ITEM_CLASS,
 SITE_NAV_DEFAULT_LIST_ITEM_CLASS,
 SITE_NAV_CUSTOM_LIST_ITEM_CLASS,
 SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX,
 SITE_NAV_DROPDOWN_ICON_ROTATED_HTML,
 SITE_NAV_DROPDOWN_ICON_HTML,
} = require('../Page/constants');
const SITE_NAV_ID = 'site-nav';
const SITE_NAV_EMPTY_LINE_REGEX = /\r?\n\s*\r?\n/g;

const SITE_NAV_LIST_ITEM_CLASS = 'site-nav-list-item';
const SITE_NAV_LIST_CLASS = 'site-nav-list';
const SITE_NAV_LIST_CLASS_ROOT = 'site-nav-list-root';

const SITE_NAV_DEFAULT_LIST_ITEM_CLASS = 'site-nav-default-list-item';
const SITE_NAV_CUSTOM_LIST_ITEM_CLASS = 'site-nav-custom-list-item';

const SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX = /:expanded:/g;
const SITE_NAV_DROPDOWN_ICON_HTML = '<i class="site-nav-dropdown-btn-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
const SITE_NAV_DROPDOWN_ICON_ROTATED_HTML = '<i class="site-nav-dropdown-btn-icon site-nav-rotate-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';

/**
 * Replaces and stores a uuid identifier to the only page-nav element, if there is one.
Expand DownExpand Up@@ -130,7 +138,7 @@ function addOverlayPortalSource(node, to) {
 * This component portals said element into the mobile navbar menus as needed.
 */
function addSitePageNavPortal(node) {
 if (node.attribs.id === 'site-nav' || node.attribs.id === 'page-nav') {
 if (node.attribs.id === SITE_NAV_ID || node.attribs.id === 'page-nav') {
 addOverlayPortalSource(node, node.attribs.id);
 } else if (node.attribs['mb-site-nav']) {
 addOverlayPortalSource(node, 'mb-site-nav');
Expand Down

8 changes: 3 additions & 5 deletions
packages/core/src/plugins/algolia.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
const cheerio = module.parent.require('cheerio');

const {
 ALGOLIA_CSS_URL,
 ALGOLIA_JS_URL,
 ALGOLIA_INPUT_SELECTOR,
} = require('../constants');
const ALGOLIA_CSS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css';
const ALGOLIA_JS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js';
const ALGOLIA_INPUT_SELECTOR = '#algolia-search-input';

function buildAlgoliaInitScript(pluginContext) {
 return `<script>
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/utils/urlUtil.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import path from 'path';
import pathIsInside from 'path-is-inside';

const {
 BOILERPLATE_FOLDER_NAME,
} = require('../constants');
const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

/**
 * Calculates the absolute path of of the immediate parent site of the specified filePath.
Expand Down

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

Skip to content
Reorganize constants in packages/core#1987

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

jonahtanjz
merged 1 commit into

from

Aug 11, 2022
 Merged


Reorganize constants in packages/core
#1987
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


2 changes: 1 addition & 1 deletion
packages/core/src/Layout/LayoutManager.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ const { Layout } = require('./Layout');

const logger = require('../utils/logger');

const { FRONT_MATTER_NONE_ATTR } = require('../Page/constants');
const FRONT_MATTER_NONE_ATTR = 'none';

class LayoutManager {
 constructor(config) {
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/Layout/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,6 @@ const { LayoutManager } = require('./LayoutManager');
module.exports = {
 Layout,
 LayoutManager,
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',
};

31 changes: 0 additions & 31 deletions
packages/core/src/Page/constants.js

View file


Open in desktop


This file was deleted.


26 changes: 13 additions & 13 deletions
packages/core/src/Page/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,16 +20,18 @@ const logger = require('../utils/logger');

const PACKAGE_VERSION = require('../../package.json').version;

const {
 PAGE_NAV_ID,
 PAGE_NAV_TITLE_CLASS,
 TITLE_PREFIX_SEPARATOR,
 TITLE_SUFFIX_SEPARATOR,
} = require('./constants');

const {
 LAYOUT_DEFAULT_NAME,
} = require('../constants');
} = require('../Layout');

const TITLE_PREFIX_SEPARATOR = ' - ';
const TITLE_SUFFIX_SEPARATOR = ' - ';

const PAGE_NAV_ID = 'mb-page-nav';
const PAGE_NAV_TITLE_CLASS = 'page-nav-title';

const SCROLL_TO_TOP_BUTTON_HTML = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" '
 + 'id="scroll-top-button" onclick="handleScrollTop()" aria-hidden="true"></i>';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

Expand DownExpand Up@@ -103,7 +105,7 @@ class Page {
 */

 /**
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter.}
 * The layout to use for this page, which may be further mutated in {@link processFrontMatter}.
 * @type {string}
 */
 this.layout = this.pageConfig.layout;
Expand DownExpand Up@@ -435,7 +437,7 @@ class Page {
 portal-ing it into the mobile page nav.
 */
 return `${pageNavTitleHtml}\n`
+ `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="mb-page-nav"`
 + `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="${PAGE_NAV_ID}"`
 + ' class="nav nav-pills flex-column my-0 small no-flex-wrap">\n'
 + `${pageNavHeadingHTML}\n`
 + '</overlay-source>\n';
Expand DownExpand Up@@ -542,9 +544,7 @@ class Page {
 }

 static addScrollToTopButton(pageData) {
 const button = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" id="scroll-top-button" '
 + 'onclick="handleScrollTop()" aria-hidden="true"></i>';
 return `${pageData}\n${button}`;
 return `${pageData}\n${SCROLL_TO_TOP_BUTTON_HTML}`;
 }

 /**
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/Site/SiteConfig.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
const logger = require('../utils/logger');

const {
 HEADING_INDEXING_LEVEL_DEFAULT,
} = require('./constants');
const HEADING_INDEXING_LEVEL_DEFAULT = 3;

/**
 * Represents a read only site config read from the site configuration file,
Expand Down

18 changes: 0 additions & 18 deletions
packages/core/src/Site/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
module.exports = {
 CONFIG_FOLDER_NAME: '_markbind',
 HEADING_INDEXING_LEVEL_DEFAULT: 3,
 SITE_FOLDER_NAME: '_site',
 TEMP_FOLDER_NAME: '.temp',
 TEMPLATE_SITE_ASSET_FOLDER_NAME: 'markbind',

 ABOUT_MARKDOWN_FILE: 'about.md',
 FAVICON_DEFAULT_PATH: 'favicon.ico',
 INDEX_MARKDOWN_FILE: 'index.md',
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES: 4,
 PAGE_TEMPLATE_NAME: 'page.njk',
 SITE_CONFIG_NAME: 'site.json',
 SITE_DATA_NAME: 'siteData.json',
 LAYOUT_SITE_FOLDER_NAME: 'layouts',
 LAZY_LOADING_SITE_FILE_NAME: 'LazyLiveReloadLoadingSite.html',
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT: 30000,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT: 5000,
 USER_VARIABLES_PATH: '_markbind/variables.md',
 WIKI_SITE_NAV_PATH: '_Sidebar.md',
 WIKI_FOOTER_PATH: '_Footer.md',
 MARKBIND_WEBSITE_URL: 'https://markbind.org/',
};

50 changes: 23 additions & 27 deletions
packages/core/src/Site/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ const { PageConfig } = require('../Page/PageConfig');
const VariableProcessor = require('../variables/VariableProcessor');
const VariableRenderer = require('../variables/VariableRenderer');
const { ExternalManager } = require('../External/ExternalManager');
const { LayoutManager } = require('../Layout');
const { LayoutManager, LAYOUT_DEFAULT_NAME, LAYOUT_FOLDER_PATH } = require('../Layout');
const { SiteLinkManager } = require('../html/SiteLinkManager');
const { PluginManager } = require('../plugins/PluginManager');
const Template = require('../../template/template');
Expand All@@ -24,11 +24,7 @@ const { delay } = require('../utils/delay');
const fsUtil = require('../utils/fsUtil');
const gitUtil = require('../utils/git');
const logger = require('../utils/logger');

const {
 LAYOUT_DEFAULT_NAME,
 LAYOUT_FOLDER_PATH,
} = require('../constants');
const { SITE_CONFIG_NAME, INDEX_MARKDOWN_FILE, LAZY_LOADING_SITE_FILE_NAME } = require('./constants');

const _ = {};
_.difference = require('lodash/difference');
Expand All@@ -50,27 +46,26 @@ url.join = path.posix.join;

const MARKBIND_VERSION = require('../../package.json').version;

const {
 ABOUT_MARKDOWN_FILE,
 CONFIG_FOLDER_NAME,
 FAVICON_DEFAULT_PATH,
 INDEX_MARKDOWN_FILE,
 LAYOUT_SITE_FOLDER_NAME,
 LAZY_LOADING_SITE_FILE_NAME,
 LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT,
 LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT,
 MARKBIND_WEBSITE_URL,
 MAX_CONCURRENT_PAGE_GENERATION_PROMISES,
 PAGE_TEMPLATE_NAME,
 SITE_CONFIG_NAME,
 SITE_DATA_NAME,
 SITE_FOLDER_NAME,
 TEMP_FOLDER_NAME,
 TEMPLATE_SITE_ASSET_FOLDER_NAME,
 USER_VARIABLES_PATH,
 WIKI_SITE_NAV_PATH,
 WIKI_FOOTER_PATH,
} = require('./constants');
const CONFIG_FOLDER_NAME = '_markbind';
const SITE_FOLDER_NAME = '_site';
const TEMP_FOLDER_NAME = '.temp';
const TEMPLATE_SITE_ASSET_FOLDER_NAME = 'markbind';
const LAYOUT_SITE_FOLDER_NAME = 'layouts';

const ABOUT_MARKDOWN_FILE = 'about.md';
const FAVICON_DEFAULT_PATH = 'favicon.ico';
const USER_VARIABLES_PATH = '_markbind/variables.md';

const PAGE_TEMPLATE_NAME = 'page.njk';
const SITE_DATA_NAME = 'siteData.json';

const WIKI_SITE_NAV_PATH = '_Sidebar.md';
const WIKI_FOOTER_PATH = '_Footer.md';

const MAX_CONCURRENT_PAGE_GENERATION_PROMISES = 4;

const LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT = 30000;
const LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT = 5000;

function getBootswatchThemePath(theme) {
 return require.resolve(`bootswatch/dist/${theme}/bootstrap.min.css`);
Expand DownExpand Up@@ -104,6 +99,7 @@ const HIGHLIGHT_ASSETS = {
const ABOUT_MARKDOWN_DEFAULT = '# About\n'
 + 'Welcome to your **About Us** page.\n';

const MARKBIND_WEBSITE_URL = 'https://markbind.org/';
const MARKBIND_LINK_HTML = `<a href='${MARKBIND_WEBSITE_URL}'>MarkBind ${MARKBIND_VERSION}</a>`;

class Site {
Expand Down

12 changes: 0 additions & 12 deletions
packages/core/src/constants.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
module.exports = {
 // Page.js and Site.js
 LAYOUT_DEFAULT_NAME: 'default.md',
 LAYOUT_FOLDER_PATH: '_markbind/layouts',

 // packages/core/src/Parser.js
 ATTRIB_CWF: 'cwf',

 BOILERPLATE_FOLDER_NAME: '_markbind/boilerplates',

 // packages/core/src/plugins/algolia.js
 ALGOLIA_CSS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css',
 ALGOLIA_JS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js',
 ALGOLIA_INPUT_SELECTOR: '#algolia-search-input',
};

4 changes: 2 additions & 2 deletions
packages/core/src/html/NodeProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,12 +28,12 @@ const { createErrorNode } = require('./elements');
const fsUtil = require('../utils/fsUtil');
const logger = require('../utils/logger');

const { FRONT_MATTER_FENCE } = require('../Page/constants');

const {
 ATTRIB_CWF,
} = require('../constants');

const FRONT_MATTER_FENCE = '---';

cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

class NodeProcessor {
Expand Down

32 changes: 20 additions & 12 deletions
packages/core/src/html/siteAndPageNavProcessor.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,17 +2,25 @@ const { v4: uuidv4 } = require('uuid');
const cheerio = require('cheerio'); require('../patches/htmlparser2');
const md = require('../lib/markdown-it');

const {
 SITE_NAV_EMPTY_LINE_REGEX,
 SITE_NAV_LIST_CLASS,
 SITE_NAV_LIST_CLASS_ROOT,
 SITE_NAV_LIST_ITEM_CLASS,
 SITE_NAV_DEFAULT_LIST_ITEM_CLASS,
 SITE_NAV_CUSTOM_LIST_ITEM_CLASS,
 SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX,
 SITE_NAV_DROPDOWN_ICON_ROTATED_HTML,
 SITE_NAV_DROPDOWN_ICON_HTML,
} = require('../Page/constants');
const SITE_NAV_ID = 'site-nav';
const SITE_NAV_EMPTY_LINE_REGEX = /\r?\n\s*\r?\n/g;

const SITE_NAV_LIST_ITEM_CLASS = 'site-nav-list-item';
const SITE_NAV_LIST_CLASS = 'site-nav-list';
const SITE_NAV_LIST_CLASS_ROOT = 'site-nav-list-root';

const SITE_NAV_DEFAULT_LIST_ITEM_CLASS = 'site-nav-default-list-item';
const SITE_NAV_CUSTOM_LIST_ITEM_CLASS = 'site-nav-custom-list-item';

const SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX = /:expanded:/g;
const SITE_NAV_DROPDOWN_ICON_HTML = '<i class="site-nav-dropdown-btn-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';
const SITE_NAV_DROPDOWN_ICON_ROTATED_HTML = '<i class="site-nav-dropdown-btn-icon site-nav-rotate-icon" '
 + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
 + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
 + '</i>';

/**
 * Replaces and stores a uuid identifier to the only page-nav element, if there is one.
Expand DownExpand Up@@ -130,7 +138,7 @@ function addOverlayPortalSource(node, to) {
 * This component portals said element into the mobile navbar menus as needed.
 */
function addSitePageNavPortal(node) {
 if (node.attribs.id === 'site-nav' || node.attribs.id === 'page-nav') {
 if (node.attribs.id === SITE_NAV_ID || node.attribs.id === 'page-nav') {
 addOverlayPortalSource(node, node.attribs.id);
 } else if (node.attribs['mb-site-nav']) {
 addOverlayPortalSource(node, 'mb-site-nav');
Expand Down

8 changes: 3 additions & 5 deletions
packages/core/src/plugins/algolia.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
const cheerio = module.parent.require('cheerio');

const {
 ALGOLIA_CSS_URL,
 ALGOLIA_JS_URL,
 ALGOLIA_INPUT_SELECTOR,
} = require('../constants');
const ALGOLIA_CSS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css';
const ALGOLIA_JS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js';
const ALGOLIA_INPUT_SELECTOR = '#algolia-search-input';

function buildAlgoliaInitScript(pluginContext) {
 return `<script>
Expand Down

4 changes: 1 addition & 3 deletions
packages/core/src/utils/urlUtil.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import path from 'path';
import pathIsInside from 'path-is-inside';

const {
 BOILERPLATE_FOLDER_NAME,
} = require('../constants');
const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';

/**
 * Calculates the absolute path of of the immediate parent site of the specified filePath.
Expand Down