天书项目常见问题解决方案

天书项目常见问题解决方案

tianshu Generate indexed single-page document with markdown and template. 项目地址: https://gitcode.com/gh_mirrors/ti/tianshu

项目基础介绍

天书（tianshu）是一个开源项目，旨在帮助用户通过Markdown和HTML模板生成带有索引的单页HTML文档。该项目的主要编程语言是JavaScript。用户可以通过简单的命令行操作，将Markdown文件和HTML模板文件编译成最终的HTML文档。

新手使用注意事项及解决方案

1. 安装问题

问题描述： 新手在安装天书时可能会遇到依赖包安装失败或命令未找到的问题。

解决步骤：

• 检查Node.js环境： 确保系统中已安装Node.js和npm。可以通过命令node -v和npm -v来验证。
• 全局安装： 使用npm install tianshu -g命令进行全局安装。如果遇到权限问题，可以在命令前加上sudo。
• 网络问题： 如果安装过程中遇到网络问题，可以尝试使用国内镜像源，例如npm install tianshu -g --registry=https://registry.npmmirror.com。

2. 模板文件配置问题

问题描述： 新手在配置模板文件时，可能会遇到Markdown文件引用错误或索引位置指定不正确的问题。

解决步骤：

• 检查模板文件： 确保模板文件中正确使用了x-markdown标签来引用Markdown文件，并且x-index标签指定了索引的输出位置。
• 文件路径： 确保Markdown文件和模板文件的路径正确，建议使用相对路径。
• 编译命令： 使用tianshu index.tpl命令进行编译，确保命令中的模板文件名正确无误。

3. 生成的HTML文档样式问题

问题描述： 新手在生成HTML文档后，可能会发现文档样式不符合预期，例如缺少CSS样式或布局混乱。

解决步骤：

• 自定义CSS： 在模板文件中添加自定义的CSS样式，确保生成的HTML文档样式符合预期。
• 检查CSS引用： 确保CSS文件正确引用，并且在模板文件中使用<link>标签或内嵌样式。
• 预览效果： 在浏览器中打开生成的HTML文件，检查样式和布局是否正确，必要时进行调整。

通过以上步骤，新手可以更好地理解和使用天书项目，解决常见问题，顺利生成带有索引的单页HTML文档。

tianshu Generate indexed single-page document with markdown and template. 项目地址: https://gitcode.com/gh_mirrors/ti/tianshu