
我们只需要运行 npx idoc init myapp
命令,就会生成一个 myapp
文件夹,已经为您的网站准备好了一个最简单的实例。如果您不是初始化一个工程,那您在创建一个文档网站前,需要做一些准备工作,规划您的网站目录。
$ npx idoc init myapp
# Or
$ npx idoc@1.4.2 init myapp
从命令行运行 idoc init myapp
生成器将创建一个包含以下元素的目录结构:
├── docs # 👈 默认文档放置目录
│ ├── README.md
│ └── about.md
├── package.json
└── idoc.yml
如果您在生成器初始化项目过程中,选择生成默认主题自己修改,那么将创建一个包含 themes
的目录结构:
├── docs
│ ├── README.md
│ └── about.md
├── idoc.yml
├── package.json
└── themes # 👈 主题目录
└── default
注意,您的配置主题值产生了变化,如下:
theme: themes/default