Git Product home page Git Product logo

kiwi-gitbook-template-default's Introduction

项目介绍

这是一个使用gitbook构建静态网站,并自动化部署到自己服务器上的一个模板项目

项目技术

  • markdown
  • gitbook
  • gulp
  • ftp
  • ssh、scp

项目目录介绍

  • src 源码目录 目录中的内容实际上就是使用gitbook init生成的内容
  • gitbook.config.js 项目构建部署配置文件,填写了一些默认项,其它的需要开发者自行补充
  • gulpfile.js gulp配置文件
  • package.json
  • README.md

gitbook.config.js 配置文件介绍

module.exports = {
  mode: 'scp', // 部署模式,有ftp和scp两种取值,必填配置,否则执行deploy命令会报错
  entry: './src', // gitbook build时的入口目录,可选配置,默认为./src
  output: './dist', // gitbook build时的输出目录,可选配置,默认为./dist
  deploy: { // 部署相关的配置
    projectName: 'xxx', // 部署到服务器的项目名称,即文件夹名称
    rootPath: 'xxx', // 欲部署到服务器的路径
    connectOptions: { // 与服务器建立链接的相关配置 对于ftp模式,以下配置即为ftp模块 ftp.connect()方法的参数
      host: 'xxx', // 主机
      user: 'xxx', // 用户名
      password: 'xxx' // 密码
    }
  },
  devServer: { // 开发服务器相关配置
    port: 4000, // 端口号,默认为4000
    open: false, // 是否自动打开浏览器,默认false
    watch: true, // 是否监听文件的变化,自动刷新,默认true
  }
}

运行脚本

# 开发预览
npm run dev
# 项目构建
npm run build
# 项目发布
npm run deploy

相关参考

kiwi-gitbook-template-default's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.