feat(theme): make docs editable on remote Git hosting platform

.gitignore

@@ -22,7 +22,11 @@ node_modules/
 /.knosys/sites/default/themes/*/layout/*
 !/.knosys/sites/default/themes/*/layout/_nop/
 /.knosys/sites/default/themes/*/scripts/
-/.knosys/sites/default/themes/*/source/
+/.knosys/sites/default/themes/*/source/fonts/*
+/.knosys/sites/default/themes/*/source/images/*
+!/.knosys/sites/default/themes/*/source/images/nop/
+/.knosys/sites/default/themes/*/source/javascripts/*
+/.knosys/sites/default/themes/*/source/stylesheets/*
 !/.knosys/sites/default/themes/*/_config.yml
 /.knosys/sites/default/public/
 /.knosys/sites/default/.deploy*/

.knosys/scripts/helper/nop-project.js

@@ -1,7 +1,7 @@
 const { resolve: resolvePath } = require('path');
 const { existsSync } = require('fs');
-const { isArray, isPlainObject, capitalize } = require('@ntks/toolbox');
-const { resolveRootPath, getConfig, isDirectory, ensureDirExists, readData, saveData, normalizeFrontMatter } = require('@knosys/sdk');
+const { isString, isArray, isPlainObject, capitalize } = require('@ntks/toolbox');
+const { resolveRootPath, getConfig, isDirectory, ensureDirExists, readData, readMeta, saveData, normalizeFrontMatter } = require('@knosys/sdk');
 const { execute } = require('ksio');
 
 function resolveSiteSrcDir(site) {
@@ -88,10 +88,28 @@ function resolveCustomizedDocToc(srcPath, items, parentUri, docData) {
   return resolved;
 }
 
+function resolveRepoSource(sourceUrl) {
+  return {
+    host: new URL(sourceUrl).hostname,
+    url: sourceUrl,
+  };
+}
+
 function resolveRepoData(site, config, existsRepos = {}) {
   const rootPath = resolveRootPath();
-  const siteDataDir = resolvePath(rootPath, `${resolveSiteSrcDir(site)}${config.generator === 'hexo' ? '/source' : ''}/_data`);
 
+  let distDataDir;
+  let distDocDir;
+
+  if (config.generator === 'hexo') {
+    distDataDir = '/source';
+    distDocDir = 'knosys';
+  } else {
+    distDataDir = '';
+    distDocDir = '_knosys';
+  }
+
+  const siteDataDir = resolvePath(rootPath, `${resolveSiteSrcDir(site)}${distDataDir}/_data`);
   const projectRepos = {};
 
   Object.entries(config.data).forEach(([srcKey, srcDir]) => {
@@ -113,11 +131,23 @@ function resolveRepoData(site, config, existsRepos = {}) {
     }
 
     const projectSlug = srcKey.replace(/^project\-/, '');
+    const source = { local: `${distDocDir}/${srcKey}` };
+
+    const { editable } = readMeta(srcPath);
+
+    if (editable) {
+      if (isString(editable)) {
+        source.remote = { default: resolveRepoSource(editable) };
+      } else if (isPlainObject(editable)) {
+        source.remote = Object.entries(editable).reduce((prev, [locale, sourceUrl]) => ({ ...prev, [locale]: resolveRepoSource(sourceUrl) }), {});
+      }
+    }
 
     projectRepos[projectSlug] = {
       name: `${projectSlug.split('-').map(w => capitalize(w)).join(' ')} 项目文档`,
       base: `/projects/${projectSlug}`,
       collection: 'docs',
+      source,
       toc,
       customized,
     };

.knosys/sites/default/_config.yml

@@ -72,7 +72,7 @@ tag_map:
 
 # Metadata elements
 ## https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta
-meta_generator: true
+meta_generator: false
 
 # Date / Time format
 ## Hexo uses Moment.js to parse and display date
@@ -99,8 +99,6 @@ ignore:
 ## Themes: https://hexo.io/themes/
 theme: nop-project
 theme_config:
-  brand:
-    # icon: "logo"
   header:
     navs:
       - text: 学习

.knosys/sites/default/source/_data/local/repos.yml

@@ -8,6 +8,15 @@ nop-entropy:
   name: Nop Entropy 项目文档
   base: /projects/nop-entropy
   collection: docs
+  source:
+    local: knosys/project-nop-entropy
+    remote:
+      default:
+        host: github.com
+        url: 'https://github.com/entropy-cloud/nop-entropy/edit/master/docs/:path'
+      zh:
+        host: gitee.com
+        url: 'https://gitee.com/canonical-entropy/nop-entropy/edit/master/docs/:path'
   toc:
     - text: 介绍
       slug: why-nop

.knosys/sites/default/themes/nop-project/_config.yml

@@ -2,6 +2,7 @@ meta:
   url: https://nop-platform.gitee.io
 brand:
   text: Nop
+  icon: "images/nop/logo.png"
   color: "#0871ab"
 copyright:
   owner:

.knosys/sites/default/themes/nop-project/layout/_nop/layouts/doc.ejs

@@ -13,7 +13,24 @@
         <%- partial('_ksio/slots/header') %>
       </header>
       <div class="Article-content col-md-9"><%- partial('_ksio/slots/content') %></div>
-      <footer class="Article-footer col-md-3"><%- partial('_ksio/slots/footer') %></footer>
+      <footer class="Article-footer col-md-3">
+        <% if (repo && repo.source && repo.source.remote &&  repo.source.remote.default) { %>
+          <% const repoSource = repo.source.remote.zh || repo.source.remote.default %>
+          <% let sourceUrl = repoSource.url %>
+          <% let sourceText %>
+          <% if (repoSource.host === 'github.com') { %>
+            <% sourceText = 'GitHub' %>
+          <% } else if (repoSource.host === 'gitee.com') { %>
+            <% sourceText = 'Gitee' %>
+          <% } %>
+          <% if (sourceUrl && sourceText) { %>
+            <div class="Widget">
+              <div class="Widget-body"><a href="<%= sourceUrl.replace(':path', page.source.replace(`${repo.source.local}/`, '')) %>" target="_blank" rel=" rel="external nofollow"">在 <%= sourceText %> 上编辑文档内容</a></div>
+            </div>
+          <% } %>
+        <% } %>
+        <%- partial('_ksio/slots/footer') %>
+      </footer>
     </article>
     <%- partial(theme.footer && theme.footer.partial || '_ksio/partials/footer') %>
   </main>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nop/website",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Official website",
   "private": true,
   "main": "index.js",
@@ -18,20 +18,15 @@
   },
   "dependencies": {
     "hexo": "^6.3.0",
-    "hexo-generator-archive": "^2.0.0",
-    "hexo-generator-category": "^2.0.0",
-    "hexo-generator-index": "^3.0.0",
-    "hexo-generator-tag": "^2.0.0",
     "hexo-renderer-coffeescript": "^0.2.0",
     "hexo-renderer-ejs": "^2.0.0",
     "hexo-renderer-marked": "^6.0.0",
     "hexo-renderer-sass": "^0.4.0",
-    "hexo-renderer-stylus": "^2.1.0",
     "hexo-server": "^3.0.0"
   },
   "devDependencies": {
     "@ntks/toolbox": "0.0.6",
     "hexo-theme-lime": "0.0.0-alpha.1",
-    "ksio": "0.0.1"
+    "ksio": "0.0.2"
   }
 }