README.md转PDF

有GitHub项目的README.md?将它转换成专业的PDF, 用于文档归档、作品集或演示。

为什么要把README转成PDF?

完全支持GitHub Flavored Markdown

Markdown Free支持GitHub Flavored Markdown (GFM)的所有功能:

如何转换README

  1. 下载README — 在GitHub仓库打开README.md, 点击「Raw」,保存文件
  2. 上传到Markdown Free — 将文件拖放到上传区域
  3. 检查预览 — 确认格式正确
  4. 导出 — 点击「转PDF」下载

示例:典型的README

# 项目名称

项目的简短描述。

## 安装

```bash
npm install project-name
```

## 使用方法

```javascript
import { myFunction } from 'project-name';
myFunction();
```

## 功能特性

- [x] 已完成的功能
- [ ] 开发中的功能

## 许可证

MIT

这个README会以完美的格式转换为PDF: 标题、代码块(带语法高亮)、清单等 都会完美呈现。

常见问题

README中的图片会被包含吗?

绝对URL(如 https://...)的图片会被包含在PDF中。 相对路径的图片可能无法正确显示。 建议使用完整URL。

可以转换仓库中的其他Markdown文件吗?

当然可以!CHANGELOG.md、CONTRIBUTING.md、/docs文件夹中的 文档等任何.md文件都支持。

可以自定义PDF格式吗?

目前PDF使用针对可读性优化的专业布局。 我们正在考虑在未来版本中添加自定义选项。

把README转换成专业文档

立即免费试用