浏览代码

Welcome page + project renaming leftovers

NGPixel 8 年之前
父节点
当前提交
ebddba0d2a
共有 13 个文件被更改,包括 95 次插入54 次删除
  1. 2 2
      .travis.yml
  2. 5 0
      README.md
  3. 1 1
      agent.js
  4. 0 0
      assets/css/app.css
  5. 2 1
      client/scss/app.scss
  6. 15 0
      client/scss/pages/_welcome.scss
  7. 28 28
      config.sample.yml
  8. 10 4
      controllers/pages.js
  9. 2 2
      gulpfile.js
  10. 12 12
      package.json
  11. 2 2
      server.js
  12. 0 2
      views/common/header.pug
  13. 16 0
      views/pages/welcome.pug

+ 2 - 2
.travis.yml

@@ -29,8 +29,8 @@ deploy:
   api_key:
     secure: TyasQ2QnWQoBhsiwm88oHoeJ+PWBZnbWEJwu6JdN5HA9cXqIdHqd1msCh84gGtKRfL2EObw4AvDwLSEd5mIM0cmQfTiokYbmb7OSjOq880rbZwtXt9t9KkC5b+TIxkhJzkzi7vIpssTeNkVJBbo/R3m0suaCRqzypkW5mhVcsFhhZ8oVCZnI1uZAXCwFNMcFFUAHxWYE98tW5bfxknRU1NJFcXysN8VXskIZ82wQQBAzZ1aQgVyMl6Uw2hns399hxCx8gVKWOIdbpO1bliHBMdm5z+lR5i723IQnHpYJf4gWvPf3oHnSS1ocrJeWVoBqanC5Iu3QhwOvPLPw/AUcJOqhvS/QiGZ2AuA9GwtBpYNVYYGD9RqcODBKZy0fWluwCuVNNoQHmwMWVP7lRnwP+SNtLzzV5ZC8mrjb4B9KGoBUR8Q7lz8cMtLoPOixk1WdWOpIFzKcw/fy8Ze6cnnFKrzsPVUZy3E3SKit3GuP6Nd7ghO0Kxp4x0eAlqFDYRZ9nG55ctd0i2b5u1r+VArt21dk2aMFxL6i67funIraEndLQFHhRgPVmjemJBRXf8j8OYrGStTsm0S26IXo3iVh/NJakIg6mEFJ3j4BXPEjCUmIW0iD6sKGTeNH6jaON+DV4T+ErGnYzgwO5KIfo9cI00DqjG0tjBQ45lWaLGy6PEo=
   file:
-  - dist/requarks-wiki.zip
-  - dist/requarks-wiki.tar.gz
+  - dist/wiki-js.zip
+  - dist/wiki-js.tar.gz
   skip_cleanup: true
   overwrite: true
   on:

+ 5 - 0
README.md

@@ -35,6 +35,11 @@
 - [x] Background Agent (git sync, cache purge, etc.)
 - [x] Caching
 - [x] Create Entry
+- [x] Documentation
+	- [x] Prerequisites
+	- [x] Install
+	- [ ] Authentication
+	- [ ] Git
 - [x] Edit Entry
 - [x] Git Management
 - [ ] Markdown Editor

+ 1 - 1
agent.js

@@ -1,5 +1,5 @@
 // ===========================================
-// REQUARKS WIKI - Background Agent
+// Wiki.js - Background Agent
 // 1.0.0
 // Licensed under AGPLv3
 // ===========================================

文件差异内容过多而无法显示
+ 0 - 0
assets/css/app.css


+ 2 - 1
client/scss/app.scss

@@ -24,4 +24,5 @@ $primary: 'indigo';
 @import './layout/_header';
 //@import './layout/_content';
 
-//@import './pages/_account';
+//@import './pages/_account';
+@import './pages/_welcome';

+ 15 - 0
client/scss/pages/_welcome.scss

@@ -0,0 +1,15 @@
+.welcome {
+	text-align: center;
+	padding: 50px 0;
+	color: mc('grey', '700');
+
+	h1 {
+		margin-top: 15px;
+	}
+
+	h2 {
+		margin-top: 15px;
+		margin-bottom: 50px;
+	}
+
+}

+ 28 - 28
config.sample.yml

@@ -1,8 +1,8 @@
 #######################################################################
-# REQUARKS WIKI - CONFIGURATION                                       #
+# Wiki.js - CONFIGURATION                                             #
 #######################################################################
 # Full explanation + examples in the documentation:
-# https://requarks-wiki.readme.io/
+# https://wiki.requarks.io/install
 
 # ---------------------------------------------------------------------
 # Title of this site
@@ -31,6 +31,13 @@ paths:
   repo: ./repo
   data: ./data
 
+# ---------------------------------------------------------------------
+# Site Language
+# ---------------------------------------------------------------------
+# Possible values: en, fr
+
+lang: en
+
 # ---------------------------------------------------------------------
 # Site Authentication
 # ---------------------------------------------------------------------
@@ -53,6 +60,22 @@ auth:
     clientId: FACEBOOK_APP_ID
     clientSecret: FACEBOOK_APP_SECRET
 
+# ---------------------------------------------------------------------
+# Secret key to use when encrypting sessions
+# ---------------------------------------------------------------------
+# Use a long and unique random string (256-bit keys are perfect!)
+
+sessionSecret: 1234567890abcdefghijklmnopqrstuvxyz
+
+# ---------------------------------------------------------------------
+# Administrator email
+# ---------------------------------------------------------------------
+# An admin account will be created using the email specified here.
+# The password is set to "admin123" by default. Change it immediately
+# upon login!!!
+
+admin: admin@company.com
+
 # ---------------------------------------------------------------------
 # Database Connection String
 # ---------------------------------------------------------------------
@@ -77,29 +100,6 @@ git:
     password: MartyMcFly88
 
     # Only for SSH authentication:
-    publicKey: /etc/requarkswiki/keys/git.pub
-    privateKey: /etc/requarkswiki/keys/git.key
-    sslVerify: true
-
-# ---------------------------------------------------------------------
-# Secret key to use when encrypting sessions
-# ---------------------------------------------------------------------
-# Use a long and unique random string (256-bit keys are perfect!)
-
-sessionSecret: 1234567890abcdefghijklmnopqrstuvxyz
-
-# ---------------------------------------------------------------------
-# Administrator email
-# ---------------------------------------------------------------------
-# An admin account will be created using the email specified here.
-# The password is set to "admin123" by default. Change it immediately
-# upon login!!!
-
-admin: admin@company.com
-
-# ---------------------------------------------------------------------
-# Site Language
-# ---------------------------------------------------------------------
-# Possible values: en, fr
-
-lang: en
+    publicKey: /etc/wiki/keys/git.pem
+    privateKey: /etc/wiki/keys/git.pem
+    sslVerify: true

+ 10 - 4
controllers/pages.js

@@ -167,10 +167,16 @@ router.get('/*', (req, res, next) => {
 		}
 		return true;
 	}).error((err) => {
-		res.render('error-notexist', {
-			message: err.message,
-			newpath: safePath
-		});
+
+		if(safePath === 'home') {
+			res.render('pages/welcome');
+		} else {
+			res.render('error-notexist', {
+				message: err.message,
+				newpath: safePath
+			});
+		}
+		
 	}).catch((err) => {
 		res.render('error', {
 			message: err.message,

+ 2 - 2
gulpfile.js

@@ -206,11 +206,11 @@ gulp.task('dev', function() {
  */
 gulp.task('deploy', ['scripts', 'css', 'fonts'], function() {
 	var zipStream = gulp.src(paths.deploy)
-		.pipe(zip('requarks-wiki.zip'))
+		.pipe(zip('wiki-js.zip'))
 		.pipe(gulp.dest('dist'));
 
 	var targzStream = gulp.src(paths.deploy)
-		.pipe(tar('requarks-wiki.tar'))
+		.pipe(tar('wiki-js.tar'))
 		.pipe(gzip())
 		.pipe(gulp.dest('dist'));
 

+ 12 - 12
package.json

@@ -59,18 +59,18 @@
     "i18next-node-fs-backend": "^0.1.3",
     "js-yaml": "^3.7.0",
     "lodash": "^4.17.2",
-    "markdown-it": "^8.1.0",
+    "markdown-it": "^8.2.1",
     "markdown-it-abbr": "^1.0.4",
-    "markdown-it-anchor": "^2.5.1",
+    "markdown-it-anchor": "^2.6.0",
     "markdown-it-attrs": "^0.8.0",
     "markdown-it-emoji": "^1.3.0",
     "markdown-it-expand-tabs": "^1.0.11",
     "markdown-it-external-links": "0.0.6",
     "markdown-it-footnote": "^3.0.1",
     "markdown-it-task-lists": "^1.4.1",
-    "moment": "^2.17.0",
-    "moment-timezone": "^0.5.9",
-    "mongoose": "^4.6.8",
+    "moment": "^2.17.1",
+    "moment-timezone": "^0.5.10",
+    "mongoose": "^4.7.2",
     "multer": "^1.2.0",
     "passport": "^0.3.2",
     "passport-facebook": "^2.1.1",
@@ -90,7 +90,7 @@
     "snyk": "^1.19.1",
     "socket.io": "^1.6.0",
     "sticky-js": "^1.0.7",
-    "validator": "^6.0.0",
+    "validator": "^6.2.0",
     "validator-as-promised": "^1.0.2",
     "winston": "^2.3.0"
   },
@@ -104,7 +104,7 @@
     "font-awesome": "^4.6.3",
     "gulp": "^3.9.1",
     "gulp-babel": "^6.1.2",
-    "gulp-clean-css": "^2.0.13",
+    "gulp-clean-css": "^2.2.0",
     "gulp-concat": "^2.6.1",
     "gulp-gzip": "^1.4.0",
     "gulp-include": "^2.3.1",
@@ -120,15 +120,15 @@
     "jquery-contextmenu": "^2.2.4",
     "jquery-simple-upload": "^1.0.0",
     "jquery-smooth-scroll": "^2.0.0",
-    "merge-stream": "^1.0.0",
-    "mocha": "^3.1.2",
+    "merge-stream": "^1.0.1",
+    "mocha": "^3.2.0",
     "mocha-lcov-reporter": "^1.2.0",
     "nodemon": "^1.11.0",
     "run-sequence": "^1.2.2",
-    "snyk": "^1.20.0",
-    "sticky-js": "^1.1.5",
+    "snyk": "^1.21.2",
+    "sticky-js": "^1.1.6",
     "twemoji-awesome": "^1.0.4",
-    "vue": "^2.1.0"
+    "vue": "^2.1.4"
   },
   "snyk": true
 }

+ 2 - 2
server.js

@@ -1,6 +1,6 @@
 "use strict";
 // ===========================================
-// REQUARKS WIKI
+// Wiki.js
 // 1.0.0
 // Licensed under AGPLv3
 // ===========================================
@@ -19,7 +19,7 @@ if(IS_DEBUG) {
 // ----------------------------------------
 
 global.winston = require(CORE_PATH + 'core-libs/winston')(IS_DEBUG);
-winston.info('[SERVER] Requarks Wiki is initializing...');
+winston.info('[SERVER] Wiki.js is initializing...');
 
 // ----------------------------------------
 // Load global modules

+ 0 - 2
views/common/header.pug

@@ -3,8 +3,6 @@
 	nav.nav.stickyscroll#header
 		.nav-left
 			block rootNavLeft
-				//a.nav-item(href='/')
-					img(src='/favicons/android-icon-96x96.png', alt='Wiki')
 				a.nav-item(href='/')
 					h1
 						i.icon-layers

+ 16 - 0
views/pages/welcome.pug

@@ -0,0 +1,16 @@
+extends ../layout.pug
+
+block rootNavCenter
+
+block rootNavRight
+	i.nav-item#notifload
+
+block content
+
+	#page-type-welcome
+		.container
+			.welcome
+				img(src='/favicons/android-icon-144x144.png',alt='Wiki.js')
+				h1 Welcome to your Wiki.js!
+				h2 Let's get started and create the home page.
+				a.button.is-indigo(href='/create/home') Create Home Page

部分文件因为文件数量过多而无法显示