logo DocuPress
首页

快速开始

安装

前置条件

  • Node.js
  • 命令行终端
  • 支持Markdown语法的编辑器
    • 推荐Visual Studio Code

安装向导

npm create docu@latest

会询问以下简单几个问题:

? 请输入项目名称:
? 包名 (name):
? 版本 (version):
? 描述 (description):
? 入口文件 (main):
? 关键字 (keywords):
? 作者 (author):

创建完成后

cd <project-name>
npm install
npm run start

目录结构

|-dist
|-docs
|-views
| |-css
| |-js
| |-layouts
| |-article.njk
| |-index.njk
|-index.js
|-package.json
  • dist目录为构建后的输出目录
  • docs目录为Markdown文件目录
  • views目录为默认的模板目录
  • views/article.njk目录为默认的文章模板
  • views/index.njk目录为默认的首页模板
  • index.js 使用示例
页面导航