从现有的降价文件创建一个跨平台帮助文件

Question

我正在处理一个现有项目，该项目已有一个描述功能和任何相关信息的降价文件。
我想创建一个可以在不同平台上查看的帮助文件 windows/os/linux.
目前我已经将 markdown 文件转换为 html 文件，然后将 index.html with images 文件夹压缩为一个 zip 文件。
但是，如果可能的话，我希望有一个无需解压缩即可直接查看的帮助文件。

到目前为止，我出于特定原因拒绝了以下解决方案：

MHTML，不同平台不同浏览器可能会遇到问题需要插件
CHM 通常是基于 windows 的格式。
我尝试从 markdown 到 pdf（phantomjs、pandoc）的任何转换都没有令人满意的结果，以至于如果选择 pdf 文件应该从头开始创建，我想避免这种情况。

所以请问有没有什么办法可以实现跨平台的单个帮助文件的制作，还是应该坚持zip的方案？

Answer 1

我遇到了和你一样的问题，我终于使用了一个解决方案，在输出中只给我一个 HTML 文件。

我用 Sublime Text 编写 Markdown 内容，并使用此扩展将 Markdown 构建到 HTML 文档中：

Sublime Text Markdown Preview

它允许我生成单个 HTML 文件，嵌入 CSS（它给我一个 GitHub 类似降价渲染）和嵌入图像（使用 base64编码）。

如果需要，您可以添加特定的 CSS 样式表，并且有很多可用的自定义项。

我是这样配置插件的：

{
    "browser": "default",
    "parser": "markdown",
    "build_action": "build",
    "enable_mathjax": true,
    "enable_uml": true,
    "enable_highlight": true,
    "enable_pygments": true,
    "guess_language": true,
    "enabled_extensions": "default",
    "enabled_parsers": ["github", "markdown" ],
    "markdown_binary_map": {
        "multimarkdown": ["/usr/local/bin/multimarkdown"]
    },
    "github_mode": "markdown",
    "github_inject_header_ids": false,
    "css": ["default"],
    "allow_css_overrides": true,
    "enable_autoreload": true,
    "markdown_filetypes": [".md", ".markdown", ".mdown"],
    "html_simple": false,
    "image_path_conversion": "base64",
    "file_path_conversions": "absolute",
    "strip_critic_marks": "none",
    "strip_yaml_front_matter": false,
    "show_panel_on_build": true,
    "embed_css_for_sublime_output": true
}

我知道这是一个非常具体的关于文本编辑器的回答，但我希望它能有所帮助。

从现有的降价文件创建一个跨平台帮助文件

Create a single cross platform help file from existing markdown file

html

markdown

file-conversion