From 07814ff70cac23c4a6b78c6fa6b99fe59a25ca61 Mon Sep 17 00:00:00 2001 From: Tan Zhen Yong Date: Thu, 14 Mar 2019 16:35:51 +0800 Subject: [PATCH] Add tags to generated HTML (#757) The Agolia team has requested that we add (#754) tags to identify pages generated by MarkBind. Since this tag is part of HTML5 [1] and can be used by other external providers to identify MarkBind generated sites, we can include this tag in all MarkBind pages. We can also include the version number to allow tracking the use of different MarkBind versions, as other projects have done [2, 3]. Let's include the tag to identify MarkBind pages, as well as including the version number to track the use of different MarkBind versions. [1]: https://www.w3.org/TR/html5/document-metadata.html#generator [2]: https://github.com/hexojs/site/pull/649 [3]: https://github.com/gatsbyjs/gatsby/pull/8221 --- src/Page.js | 3 +++ src/template/page.ejs | 1 + test/functional/test_site/expected/bugs/index.html | 1 + test/functional/test_site/expected/index.html | 1 + test/functional/test_site/expected/sub_site/index.html | 1 + test/functional/test_site/expected/testAfterSetup.html | 1 + test/functional/test_site/expected/testEmptyFrontmatter.html | 1 + test/functional/test_site/expected/testExternalScripts.html | 1 + test/functional/test_site/expected/testLayouts.html | 1 + test/functional/test_site/expected/testLayoutsOverride.html | 1 + test/functional/test_site/expected/test_md_fragment.html | 1 + 11 files changed, 13 insertions(+) diff --git a/src/Page.js b/src/Page.js index 61e6a1222e..20583c84a8 100644 --- a/src/Page.js +++ b/src/Page.js @@ -17,6 +17,8 @@ const logger = require('./util/logger'); const MarkBind = require('./lib/markbind/src/parser'); const md = require('./lib/markbind/src/lib/markdown-it'); +const CLI_VERSION = require('../package.json').version; + const FOOTERS_FOLDER_PATH = '_markbind/footers'; const HEAD_FOLDER_PATH = '_markbind/head'; const LAYOUT_DEFAULT_NAME = 'default'; @@ -238,6 +240,7 @@ Page.prototype.prepareTemplateData = function () { faviconUrl: this.faviconUrl, headFileBottomContent: this.headFileBottomContent, headFileTopContent: this.headFileTopContent, + markBindVersion: `MarkBind ${CLI_VERSION}`, pageNav: this.isPageNavigationSpecifierValid(), siteNav: this.frontMatter.siteNav, title: prefixedTitle, diff --git a/src/template/page.ejs b/src/template/page.ejs index e39a0ca726..f122e87615 100644 --- a/src/template/page.ejs +++ b/src/template/page.ejs @@ -4,6 +4,7 @@ <%- headFileTopContent %> + <%= title %> diff --git a/test/functional/test_site/expected/bugs/index.html b/test/functional/test_site/expected/bugs/index.html index f578210f07..779f27900e 100644 --- a/test/functional/test_site/expected/bugs/index.html +++ b/test/functional/test_site/expected/bugs/index.html @@ -4,6 +4,7 @@ + Open Bugs diff --git a/test/functional/test_site/expected/index.html b/test/functional/test_site/expected/index.html index 7cc720553f..ddc812d6c8 100644 --- a/test/functional/test_site/expected/index.html +++ b/test/functional/test_site/expected/index.html @@ -9,6 +9,7 @@ + Hello World diff --git a/test/functional/test_site/expected/sub_site/index.html b/test/functional/test_site/expected/sub_site/index.html index cbdfdca48c..8a4001a4d7 100644 --- a/test/functional/test_site/expected/sub_site/index.html +++ b/test/functional/test_site/expected/sub_site/index.html @@ -4,6 +4,7 @@ + diff --git a/test/functional/test_site/expected/testAfterSetup.html b/test/functional/test_site/expected/testAfterSetup.html index 6d43545d74..7a82b38698 100644 --- a/test/functional/test_site/expected/testAfterSetup.html +++ b/test/functional/test_site/expected/testAfterSetup.html @@ -4,6 +4,7 @@ + Hello World diff --git a/test/functional/test_site/expected/testEmptyFrontmatter.html b/test/functional/test_site/expected/testEmptyFrontmatter.html index 4b95cd44de..20cb727475 100644 --- a/test/functional/test_site/expected/testEmptyFrontmatter.html +++ b/test/functional/test_site/expected/testEmptyFrontmatter.html @@ -4,6 +4,7 @@ + Hello World diff --git a/test/functional/test_site/expected/testExternalScripts.html b/test/functional/test_site/expected/testExternalScripts.html index cdf9a838bb..b1a9cf06ff 100644 --- a/test/functional/test_site/expected/testExternalScripts.html +++ b/test/functional/test_site/expected/testExternalScripts.html @@ -4,6 +4,7 @@ + Hello World diff --git a/test/functional/test_site/expected/testLayouts.html b/test/functional/test_site/expected/testLayouts.html index c8be01b21d..bb5cb64635 100644 --- a/test/functional/test_site/expected/testLayouts.html +++ b/test/functional/test_site/expected/testLayouts.html @@ -4,6 +4,7 @@ + Hello World diff --git a/test/functional/test_site/expected/testLayoutsOverride.html b/test/functional/test_site/expected/testLayoutsOverride.html index 3e3942f01b..474287050f 100644 --- a/test/functional/test_site/expected/testLayoutsOverride.html +++ b/test/functional/test_site/expected/testLayoutsOverride.html @@ -4,6 +4,7 @@ + Hello World diff --git a/test/functional/test_site/expected/test_md_fragment.html b/test/functional/test_site/expected/test_md_fragment.html index 59e59fdb15..e2dc014187 100644 --- a/test/functional/test_site/expected/test_md_fragment.html +++ b/test/functional/test_site/expected/test_md_fragment.html @@ -4,6 +4,7 @@ +