iDoc 1.34.1
iDoc 1.34.1
iDoc 1.34.1
默认网站首页内容通过 README.md 生成 index.html。
├── docs
│ ├── README.md # 👈 默认文档首页（优先 ⚠️ ）
│ └── about.md
├── package.json
├── idoc.yml
└── README.md # 👈 默认文档首页
默认指定输出目录添加 README.md 文件视为首页，如果没有定义 README.md，根目录下的 README.md 视为首页。这是为了支持生成单页面站点。
默认 README.md -> index.html 与 index.md -> index.html 生成的文件冲突。
├── docs
│ ├── README.md # 👈 冲突 -> `index.html`
│ └── index.md # 👈 冲突 -> `index.html`
README.md 特殊处理生成 index.html，是因为在 GitHub 默认预览 README.md，所以建议使用 README.md 作为首页命名，这可在 GitHub 和 idoc 文档保持一致的体验。
Markdown 文本中 HTML/CSS 是起作用的，可以自己定义一些内容，你可以将下面代码复制到您的文档中测试一下
⚠️ 注意：在 GitHub 中预览是无效的，会影响在 GitHub 中预览展示。
<style>
body, html { background: #fff; }
.jumbotron {
position: absolute;
left: 0;
right: 0;
background-color: #383838;
padding-top: 100px;
min-height: 300px;
color: #c1c1c1;
}
.jumbotron-block { min-height: 330px; }
.jumbotron-warpper { max-width: 1200px; margin: 0 auto; text-align: center; }
.jumbotron-title { font-size: 30px; font-weight: bold; }
</style>
<div class="jumbotron">
<div class="jumbotron-warpper">
<div class="jumbotron-title">idoc </div>
<div class="jumbotron-des">idoc 是一个文档生成工具，用于生成文档网站或简单的博客网站，简单到你只需写 Markdown 文件就可以帮助你生成网站。同时可以方便的集成到你的项目工程中。
</div>
</div>
</div>
<div class="jumbotron-block"> </div>
使用注释配置，在当前页面添加指定的模板，将当前 Markdown 使用自定义模板渲染生成 HTML，可以使用模板变量获得你需要的内容，将它渲染到页面中。
<!--idoc:config:
layout: home.ejs
-->
这里可以添加首页展示的文本内容
自定义模板 home.ejs:
<!DOCTYPE html>
<html lang="en">
<head>
<title>Document</title>
</head>
<body>
<%- html %>
</body>
</html>
生成 HTML 内容：
<!DOCTYPE html>
<html lang="en">
<head>
<title>Document</title>
</head>
<body>
<p>这里可以添加首页展示的文本内容</p>
</body>
</html>
目录结构
├── docs
│ ├── README.md # 👈 首页
│ └── about.md
├── package.json
├── home.ejs # 👈 自定义模板
├── idoc.yml