README

将 Markdown 转换为 HTML 和 PDF 简历

将简单的 Markdown 文档转换为优雅的简历，包含完美的 PDF 打印格式和响应式的 CSS3 HTML5 文件。您可以在项目的博客文章中查看示例，或在 examples/output 中查看示例 PDF。

特性

多种风格可供选择：现代、块状、无样式、可读、斯威士兰 （Fork 并添加更多！）
通过 wkhtmltopdf 生成 PDF
响应式设计，适用于多种设备视口大小
简单的 Markdown 格式化
单文件部署（无外部样式表）
您现在可以版本控制并分支您的简历。

安装

Docker

在放置您的 Markdown 简历的目录中运行以下命令。

一次性命令

这最适合在脚本或 CI 环境中使用

docker run -v ${PWD}:/resume there4/markdown-resume md2resume [options] command [arguments]

交互式控制台

这允许您进入一个交互式控制台，在那里您可以轻松地进行实验并运行不同的命令

docker run -it -v ${PWD}:/resume there4/markdown-resume

本地

克隆存储库 git clone git@github.com:there4/markdown-resume.git 或下载 ZIP
PHP 7 和 composer 已安装并位于您的 PATH 中
在项目目录中运行 composer install 以安装依赖项
要生成 PDF 文件，您需要安装 wkhtmltopdf
- OSX: 通过 Homebrew Cask 运行 brew cask install wkhtmltopdf
- Debian: 运行 sudo apt install php7.0-mbstring wkhtmltopdf
- Fedora: 运行 sudo dnf install php-mbstring wkhtmltopdf

使用

以下两个命令是最重要的。在克隆的目录中运行它们

./bin/md2resume html examples/source/sample.md examples/output/
./bin/md2resume pdf examples/source/sample.md examples/output/

帮助

Markdown Resume Generator version 2.3.0 by Craig Davis

Usage:
  [options] command [arguments]

Options:
  --help           -h Display this help message.
  --quiet          -q Do not output any message.
  --verbose        -v|vv|vvv Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  --version        -V Display this application version.
  --ansi              Force ANSI output.
  --no-ansi           Disable ANSI output.
  --no-interaction -n Do not ask any interactive question.

Available commands:
  help        Displays help for a command
  html        Generate an HTML resume from a markdown file
  list        Lists commands
  pdf         Generate a PDF from a markdown file
  stats       Generate a word frequency analysis of your resume
  templates   List available templates
  version     Show current version information

示例

使用 -t 选项选择模板。

./bin/md2resume html --template blockish examples/source/sample.md examples/output/

如果您想在浏览器中查看更新时编辑您的 Markdown 简历，请运行此命令

watch ./bin/md2resume html --refresh yes --template modern examples/source/sample.md examples/output/

这将使构建脚本定期运行，HTML 文档将通过 meta 标签每两秒刷新一次。在浏览器中打开 ./examples/ouput/sample.html 文件，然后只需在需要查看最新预览时保存您的 Markdown 文档。

编写您的简历

Markdown 仅限于基本 HTML 标记。按照 examples/source/sample.md 文件作为指南。此文件包含各种标题和多个嵌套元素。这允许我们构建语义化的 HTML 文档用于简历，然后使用 CSS 规则显示格式化的简历。请注意，因为我们有很少的嵌套或标识元素的方法，所以许多 CSS 规则基于后代和相邻选择器。

特性开发

为了添加新命令，您需要首先通过 composer install 安装依赖项

之后，您可以从命令行运行 md2resume_dev.php 文件。

构建发布

使用新构建号标记存储库。
运行 composer build。
推送标签和代码。

致谢

最初的灵感来自样本简历模板。然而，此项目中没有使用该项目的任何HTML。布局已被重用，并添加了媒体查询。这是一个很好的模板，如果你比Markdown更熟悉HTML，你应该使用它。

变更日志

2.3.1 : 使用Docker修复PDF生成中的嵌入式图像@danielklim
2.3.0 : 添加Docker支持以简化安装过程@spawnia
2.2.0 : 删除phar文件分发，移除Pake并迁移到composer命令
2.1.0 : 删除PHP5支持
2.0.12 : 添加来自@ejwaibel的新Roboto模板
2.0.10 : 根据来自@501st-alpha1的提交更新了Moder模板中的间距
2.0.9 : 更新Modern模板以改进间距。更新--template选项的解析以关闭问题 #7
2.0.8 : 由@ahmadnazir贡献的新readable主题，对支持/links目录进行轻微重构
2.0.7 : 将composer更新为使用sunra/php-simple-html-dom-parser，这似乎得到了更好的维护并且更受欢迎，以关闭 #27
2.0.6 : 修复从phar文件到关闭 #24的空模板列表
2.0.5 : 删除--refresh选项的默认值以关闭 #22
2.0.4 : 修复与绝对路径相关的路径解析问题以关闭 #16
2.0.3 : 向--refresh选项添加可选持续时间以关闭 #15
2.0.2 : 添加对mbstring的新依赖性检查以关闭 #20
2.0.1 : 添加具有Helvetica样式的新的swissen模板@beautifulcode
2.0.0 : 使用symfony控制台组件进行完全重写。现在使用编译后的phar文件进行部署，并且使用composer管理开发依赖项。
0.9.0 : 添加composer并更新README以包含新变更日志
0.8.8 : 添加中文文本示例@ishitcno1
0.8.7 : 更新Modern模板的pdf格式@roleary
0.8.6 : 修复输出路径@abhikandoi2000
0.8.5 : 修复问题 #2
0.8.4 : 更正chmod并添加输出目录参数@kevinxucs
0.8.2 : 更新构建脚本并添加刷新命令选项
0.8.1 : 更新初始模板的格式
0.8 : 向公众发布初始版本

there4 / markdown-resume

维护者

详细信息