Test: Update test_site expected folder

MarkBind · Mar 20, 2019 · 1e7b75f · 1e7b75f
1 parent 26a39f9
commit 1e7b75f
Show file tree

Hide file tree

Showing 29 changed files with 758 additions and 658 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/docs/userGuide/makingTheSiteSearchable.md b/docs/userGuide/makingTheSiteSearchable.md
@@ -37,6 +37,7 @@ If you do not wish to use MarkBind's searchbar (e.g. you have an external servic
 
 <include src="syntax/searchBars.mbdf" />
 <include src="syntax/keywords.mbdf" />
+<include src="syntax/indexing.mbdf" />
 
 {% from "njk/common.njk" import previous_next %}
 {{ previous_next('reusingContents', 'deployingTheSite') }}
diff --git a/docs/userGuide/syntax/indexing.mbdf b/docs/userGuide/syntax/indexing.mbdf
@@ -0,0 +1,16 @@
+## Including or Excluding Headings
+
+**You can specify headings which are to be included or excluded from the index built by MarkBind's built-in search feature** using the `.always-index` or `.no-index` attributes.
+
+If you wish to index a specific heading outside the specified `headingIndexLevel`, you may add the `.always-index` attribute to the heading. Similarly, if you wish for a specific heading inside the specified `headingIndexLevel` not to be indexed, you may add the `.no-index` attribute to the heading.
+
+<div class="indented">
+
+{{ icon_example }}
+
+```md
+###### Heading outside heading index level that will be indexed {.always-index}
+
+# Heading inside heading index level that will not be indexed {.no-index}
+```
+</div>
diff --git a/src/Page.js b/src/Page.js
@@ -190,15 +190,17 @@ function formatSiteNav(renderedSiteNav, src) {
 }
 
 /**
- * Generates a heading selector based on the indexing level
+ * Generates a selector for headings with level inside the headingIndexLevel
+ * or with the index attribute, that do not also have the noindex attribute
  * @param headingIndexingLevel to generate
  */
 function generateHeadingSelector(headingIndexingLevel) {
-  let headingsSelector = 'h1';
+  let headingsSelectors = ['.always-index:header', 'h1'];
   for (let i = 2; i <= headingIndexingLevel; i += 1) {
-    headingsSelector += `, h${i}`;
+    headingsSelectors.push(`h${i}`);
   }
-  return headingsSelector;
+  headingsSelectors = headingsSelectors.map(selector => `${selector}:not(.no-index)`);
+  return headingsSelectors.join(',');
 }
 
 function unique(array) {

diff --git a/src/lib/markbind/src/parser.js b/src/lib/markbind/src/parser.js
@@ -305,14 +305,12 @@ Parser.prototype._preprocess = function (node, context, config) {
     delete element.attribs.inline;
     delete element.attribs.trim;
 
-    fileContent = isTrim ? fileContent.trim() : fileContent;
-
     if (includeSrc.hash) {
       // directly get segment from the src
       const segmentSrc = cheerio.parseHTML(fileContent, true);
       const $ = cheerio.load(segmentSrc);
-      const htmlContent = $(includeSrc.hash).html();
-      let actualContent = htmlContent;
+      const hashContent = $(includeSrc.hash).html();
+      let actualContent = (hashContent && isTrim) ? hashContent.trim() : hashContent;
 
       if (actualContent === null) {
         if (isOptional) {
@@ -343,7 +341,7 @@ Parser.prototype._preprocess = function (node, context, config) {
       }
       element.children = cheerio.parseHTML(actualContent, true); // the needed content;
     } else {
-      let actualContent = fileContent;
+      let actualContent = (fileContent && isTrim) ? fileContent.trim() : fileContent;
       if (isIncludeSrcMd) {
         if (context.mode === 'include') {
           actualContent = isInline ? actualContent : utils.wrapContent(actualContent, '\n\n', '\n');

diff --git a/test/functional/test_site/_markbind/layouts/default/head.md b/test/functional/test_site/_markbind/layouts/default/head.md
@@ -1,4 +1,4 @@
-<head-top>
-<meta name="default-head-top">
-</head-top>
-<meta name="default-head-bottom">
+<head-top>
+<meta name="default-head-top">
+</head-top>
+<meta name="default-head-bottom">
diff --git a/test/functional/test_site/_markbind/layouts/testAfterSetup/head.md b/test/functional/test_site/_markbind/layouts/testAfterSetup/head.md
@@ -1,4 +1,4 @@
-<head-top>
-<meta name="head-top">
-</head-top>
-<meta name="head-bottom">
+<head-top>
+<meta name="head-top">
+</head-top>
+<meta name="head-bottom">
diff --git a/test/functional/test_site/_markbind/layouts/testLayout/head.md b/test/functional/test_site/_markbind/layouts/testLayout/head.md
@@ -1,4 +1,4 @@
-<head-top>
-<meta name="head-top">
-</head-top>
-<meta name="head-bottom">
+<head-top>
+<meta name="head-top">
+</head-top>
+<meta name="head-bottom">
diff --git a/test/functional/test_site/expected/bugs/index.html b/test/functional/test_site/expected/bugs/index.html
@@ -21,8 +21,9 @@
     <link rel="icon" href="/test_site/favicon.png">
 </head>
 <body>
-<div id="app">
-    <div id="content-wrapper">
+    <div id="app">
+                <div id="flex-body">
+                        <div id="content-wrapper">
   <div>
     <navbar placement="top" type="inverse" class="temp-navbar">
       <a slot="brand" href="/" title="Home" class="navbar-brand">Markbind Test Site</a>
@@ -40,7 +41,8 @@ <h2 id="popover-initiated-by-trigger-honor-trigger-attribute">popover initiated
       <div slot="content">
         <div>
           <p>Requirements gathering, requirements elicitation, requirements analysis, requirements capture are some of the terms commonly <strong>and</strong> interchangeably used to represent the activity of understanding what a software product should
-            do.</p>
+            do.
+          </p>
         </div>
       </div>
     </popover>
@@ -54,7 +56,8 @@ <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a
       <modal large="" title="Establishing Requirements" id="modal:bugRepro">
         <div>
           <p>Requirements gathering, requirements elicitation, requirements analysis, requirements capture are some of the terms commonly <strong>and</strong> interchangeably used to represent the activity of understanding what a software product should
-            do.</p>
+            do.
+          </p>
         </div>
       </modal>
     </div>
@@ -65,7 +68,8 @@ <h2 id="support-multiple-inclusions-of-a-modal">Support multiple inclusions of a
       <modal large="" title="Establishing Requirements" id="modal:bugRepro">
         <div>
           <p>Requirements gathering, requirements elicitation, requirements analysis, requirements capture are some of the terms commonly <strong>and</strong> interchangeably used to represent the activity of understanding what a software product should
-            do.</p>
+            do.
+          </p>
         </div>
       </modal>
     </div>
@@ -76,13 +80,12 @@ <h2 id="remove-extra-space-in-links">Remove extra space in links<a class="fa fa-
       <a href="https://github.com">link text</a>]</p>
   </div>
 </div>
-<div id="flex-div"></div>
-<footer>
+                    </div>
+        <footer>
   <div class="text-center">
     Default footer
   </div>
-</footer>
-</div>
+</footer>    </div>
 </body>
 <script src="../markbind/js/vue.min.js"></script>
 <script src="../markbind/js/vue-strap.min.js"></script>