From e8fc1d61949d228d77e0b3be5fcbffbc6c1fcd74 Mon Sep 17 00:00:00 2001 From: Gilad S Date: Mon, 21 Mar 2022 23:37:05 +0200 Subject: [PATCH 1/4] feat: add Algolia DocSearch to documentation site The `apiKey`, `appId` and `indexName` parameters specified in `MainPage.js` should be updated in order for the search to work --- index.html | 2 ++ script/component/MainPage.js | 10 ++++++++++ 2 files changed, 12 insertions(+) diff --git a/index.html b/index.html index ae195c3..a262cd2 100644 --- a/index.html +++ b/index.html @@ -15,6 +15,7 @@ + @@ -45,6 +46,7 @@ + diff --git a/script/component/MainPage.js b/script/component/MainPage.js index 3a48695..eba84bf 100644 --- a/script/component/MainPage.js +++ b/script/component/MainPage.js @@ -25,6 +25,9 @@ const MainPage = { --> +
  • +
    +
  • @@ -102,6 +105,13 @@ const MainPage = { scriptEl.setAttribute('id', '_carbonads_js'); scriptEl.setAttribute('async', null); this.$refs.carbon.appendChild(scriptEl); + + docsearch({ + container: '#docsearch', + appId: 'YOUR_APP_ID', // TODO: replace with `appId` from https://docsearch.algolia.com/apply/ + indexName: 'YOUR_INDEX_NAME', // TODO: replace with `indexName` from https://docsearch.algolia.com/apply/ + apiKey: 'YOUR_SEARCH_API_KEY' // TODO: replace with `apiKey` from https://docsearch.algolia.com/apply/ + }); }, methods: { goToLink: function () { From 3e2836906d4fcbf4e1aded928e19d425b94c3caf Mon Sep 17 00:00:00 2001 From: Gilad S Date: Thu, 24 Mar 2022 21:33:16 +0200 Subject: [PATCH 2/4] fix: update Algolia DocSearch configuration --- script/component/MainPage.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/script/component/MainPage.js b/script/component/MainPage.js index eba84bf..1795f52 100644 --- a/script/component/MainPage.js +++ b/script/component/MainPage.js @@ -108,9 +108,9 @@ const MainPage = { docsearch({ container: '#docsearch', - appId: 'YOUR_APP_ID', // TODO: replace with `appId` from https://docsearch.algolia.com/apply/ - indexName: 'YOUR_INDEX_NAME', // TODO: replace with `indexName` from https://docsearch.algolia.com/apply/ - apiKey: 'YOUR_SEARCH_API_KEY' // TODO: replace with `apiKey` from https://docsearch.algolia.com/apply/ + appId: '2UUKVSBT3M', + indexName: 'typeorm', + apiKey: '8392de2c2e76d873b60bf10562aab788' }); }, methods: { From ec15d517d2e8e352b6e1fb0e1d3f9bbcbfc97513 Mon Sep 17 00:00:00 2001 From: Gilad S Date: Thu, 24 Mar 2022 23:36:52 +0200 Subject: [PATCH 3/4] feat: change Vue router's mode from "hash" to "history" to support search engine indexing In order to support loading a deep url without getting a 404 error, a custom 404.html page is implemented to redirect back to index.html which uses history api to load the original url without a refresh. Based on #36 --- 404.html | 27 +++++++++++++++++++++++++ index.html | 8 ++++++++ script/component/DocumentPage.js | 8 ++++---- script/component/MarkdownReader.js | 32 +++++++++++++++++------------- script/index.js | 28 ++++++++++++++++++++------ 5 files changed, 79 insertions(+), 24 deletions(-) create mode 100644 404.html diff --git a/404.html b/404.html new file mode 100644 index 0000000..28395d2 --- /dev/null +++ b/404.html @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + TypeORM - Amazing ORM for TypeScript and JavaScript (ES7, ES6, ES5). Supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, WebSQL databases. Works in NodeJS, Browser, Ionic, Cordova and Electron platforms. + + + + + diff --git a/index.html b/index.html index a262cd2..6253ea0 100644 --- a/index.html +++ b/index.html @@ -5,6 +5,14 @@ + + - +
    {{$t("contribute")}} {{$t("edit")}} @@ -11,7 +11,7 @@ const DocumentPage = { data: function() { return { document: this.$route.params.document, - fragment: this.$route.params.fragment, + hash: this.$route.hash, locale: $cookies.get("locale") || "en", readLink: "https://raw.githubusercontent.com/typeorm/typeorm/master/", editLink: "https://github.com/typeorm/typeorm/edit/master/" @@ -20,7 +20,7 @@ const DocumentPage = { watch: { '$route': function(to, from) { this.document = to.params.document; - this.fragment = to.params.fragment; + this.hash = to.hash; this.updateTitle(); } }, @@ -58,4 +58,4 @@ const DocumentPage = { } } } -}; \ No newline at end of file +}; diff --git a/script/component/MarkdownReader.js b/script/component/MarkdownReader.js index a584c70..b12566e 100644 --- a/script/component/MarkdownReader.js +++ b/script/component/MarkdownReader.js @@ -1,6 +1,6 @@ const MarkdownReader = { template: `
    `, - props: ["file", "fragment"], + props: ["file", "hash"], data: function() { return { html: "", @@ -12,27 +12,31 @@ const MarkdownReader = { this.setDocument(); this.loadFile(file) .then(() => { - this.scrollToFragment(this.fragment); + this.scrollToHash(this.hash); }); }, - 'fragment': function(fragment) { - this.scrollToFragment(fragment); + 'hash': function(hash) { + this.scrollToHash(hash); } }, created: function () { this.setDocument(); this.loadFile(this.file) .then(() => { - this.scrollToFragment(this.fragment); + this.scrollToHash(this.hash); }); }, methods: { - scrollToFragment: function(fragment) { - const fragmentElement = document.getElementById(fragment); - if (fragmentElement) - fragmentElement.scrollIntoView(); - else - window.scrollTo(0, 0); + scrollToHash: function(hash) { + if (hash) { + const fragmentElement = document.getElementById(hash.substring("#".length)); + if (fragmentElement) { + fragmentElement.scrollIntoView(); + return; + } + } + + window.scrollTo(0, 0); }, setDocument: function () { if(this.$route.params.document) { @@ -51,7 +55,7 @@ const MarkdownReader = { showdown.extension('header-anchors', () => { - var ancTpl = '$1 $4'; + var ancTpl = '$1 $4'; return [{ type: "html", @@ -64,7 +68,7 @@ const MarkdownReader = { return [{ type: "html", regex: //g, - replace: "" + replace: "" }]; }); @@ -72,7 +76,7 @@ const MarkdownReader = { return [{ type: "html", regex: //g, - replace: "" + replace: "" }]; }); diff --git a/script/index.js b/script/index.js index 5eba223..dad62fe 100644 --- a/script/index.js +++ b/script/index.js @@ -11,14 +11,30 @@ const i18n = new VueI18n({ messages // set locale messages }) +const router = new VueRouter({ + mode: "history", + routes: [ + { path: "/:document?/:fragment?", component: DocumentPage }, + ] +}); + +// Because the documentation previously used "hash" mode in the Router, paths +// starting with a hash will be redirected to prevent breaking old permalinks. +router.beforeEach((to, from, next) => { + if (to.fullPath.startsWith("/#/")) { + // Remove leading hash and replace following slash with hash. + // Before: https://typeorm.io/#/entities/entity-columns + // After: https://typeorm.io/entities#entity-columns + const path = "/" + to.fullPath.substring("/#/".length).replace("/", "#"); + next(path); + } else + next(); +}); + new Vue({ el: "#app", i18n, - router: new VueRouter({ - routes: [ - { path: "/:document?/:fragment?", component: DocumentPage }, - ] - }), + router: router, components: { "main-page": MainPage, "markdown-reader": MarkdownReader, @@ -27,4 +43,4 @@ new Vue({ i18n.locale = $cookies.get("locale") || "en"; document.title = this.$t("title"); } -}); \ No newline at end of file +}); From ae416e6f3ef0935bbc9244d5a50a97cdaea8058e Mon Sep 17 00:00:00 2001 From: Gilad S Date: Thu, 24 Mar 2022 23:54:45 +0200 Subject: [PATCH 4/4] fix: main page title links --- script/component/MarkdownReader.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/component/MarkdownReader.js b/script/component/MarkdownReader.js index b12566e..522bdc5 100644 --- a/script/component/MarkdownReader.js +++ b/script/component/MarkdownReader.js @@ -68,7 +68,7 @@ const MarkdownReader = { return [{ type: "html", regex: //g, - replace: "" + replace: "" }]; });