chore: Add footer to the conf.

jaywcjlove · Sep 3, 2019 · 6e59b97 · 6e59b97
1 parent 3f92923
commit 6e59b97
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 7 deletions.
diff --git a/src/conf/path.js b/src/conf/path.js
@@ -25,7 +25,7 @@ function getRdocConf() {
   return conf;
 }
 
-function getCinfigFilePath(fileName, type) {
+function getConfigFilePath(fileName, type) {
   const conf = getRdocConf();
   // 这里是读取配置
   if (conf && conf[type]) {
@@ -55,21 +55,21 @@ function getCinfigFilePath(fileName, type) {
 
 // Get favicon path
 const faviconPath = () => {
-  const _path = getCinfigFilePath('./favicon.ico', 'favicon');
+  const _path = getConfigFilePath('./favicon.ico', 'favicon');
   if (_path) return _path;
   return resolveTool('../../theme/default/favicon.ico');
 };
 
 // Get logo path
 const logoPath = () => {
-  const _path = getCinfigFilePath('./logo.svg', 'logo');
+  const _path = getConfigFilePath('./logo.svg', 'logo');
   if (_path) return _path;
   return false;
 };
 
 // Get theme path
 const getThemePath = () => {
-  const _path = getCinfigFilePath('./default', 'theme');
+  const _path = getConfigFilePath('./default', 'theme');
   if (_path) return _path;
   return resolveTool('../../theme/default');
 };

diff --git a/src/conf/webpack.config.js b/src/conf/webpack.config.js
@@ -5,6 +5,9 @@ const UPATH = require('upath');
 const paths = require('./path');
 const pkg = require('../../package.json');
 
+const define = paths.rdocConf && paths.rdocConf.footer && typeof paths.rdocConf.footer === 'string'
+  ? { FOOTER: JSON.stringify(paths.rdocConf.footer) } : {};
+
 module.exports = {
   entry: {},
   output: {
@@ -91,6 +94,7 @@ module.exports = {
     new WebpackBar({ name: pkg.name }),
     new webpack.DefinePlugin({
       VERSION: JSON.stringify(pkg.version),
+      ...define,
     }),
   ],
   node: {

diff --git a/templates/default/introduce/api/conf.md b/templates/default/introduce/api/conf.md
@@ -26,6 +26,7 @@ sort: 4
 +    "theme": "rdoc-theme-load-react",
 +    "favicon": "./assets/favicon.ico",
 +    "logo": "./assets/rdoc.logo.svg",
++    "footer": "前端<b>开</b>发"
 +    "react_modules": {
 +      "Hotkeys": "react-hot-keys"
 +    }
@@ -83,3 +84,7 @@ sort: 4
 这个参数是一个特定参数，需求是在制作主题的时候，你的主题需要预览 React 实例，实例还需要加载一些未知的第三方 React 组件，这个时候你需要在你的 Markdown 项目中安装你需要的 React 组件，在配置中指定你的组件，在预览实例中你就可以引用该组件了。
 
 > ⚠️注意：还在研究实现方式。
+
+### footer
+
+更改文档网站页脚
diff --git a/theme/default/component/Footer/index.js b/theme/default/component/Footer/index.js
@@ -3,12 +3,18 @@ import styles from './index.less';
 
 const version = VERSION; // eslint-disable-line
 
-const Footer = () => {
+const footer = FOOTER; // eslint-disable-line
+
+const FooterView = () => {
   return (
     <div className={styles.footer}>
-      Copyright © 2018 Powered by <a target="_blank" rel="noopener noreferrer" href="https://github.com/jaywcjlove/rdoc">RDoc {version}</a>.
+      {footer ? <div dangerouslySetInnerHTML={{ __html: footer }} /> : (
+        <div>
+          Copyright © 2018 Powered by <a target="_blank" rel="noopener noreferrer" href="https://github.com/jaywcjlove/rdoc">RDoc {version}</a>.
+        </div>
+      )}
     </div>
   );
 };
 
-export default Footer;
+export default FooterView;