cargo-markdown

快速为您的crates.io页面创建优秀的readme文件！

一个cargo子命令，可以在默认浏览器中预览您的crate的readme文件，并在crates.io网站的几乎像素完美的热重载原型中进行。

⚡快速开始

确保您已安装Rust和Cargo，然后使用以下命令安装：

cargo install cargo-markdown

从您的项目目录中运行

# your readme file must already exist at the path you specify
cargo markdown ./readme.md 

在浏览器中打开提供的地址，您将看到crates.io网站原型中的readme文件。

现在您可以在您选择的编辑器中编辑您的readme文件。每次保存文件时，预览网页都会立即热重载。

🎯 功能

• 与官方crates.io网站相同的markdown渲染代码和样式
• 与官方crates.io网站相同的响应式断点，您可以在移动格式中测试布局
• readme文件更新时的超快速热重载
• 使用实时移动设备通过ngrok进行测试
• 通过传递--open标志自动打开您的默认浏览器
• 跟踪您在每次会话中进行的readme更新次数

⚙️ 使用方法

USAGE:
    cargo markdown [OPTIONS] <README> [PORT]

ARGS:
    <README>    📄 The path to your readme file
    <PORT>      🚢 The port used by the preview server [default: 8080]

<OPTIONS>
    -h, --help           ❔ Print help information
    -p, --port <PORT>    🚢 The port used by the preview server [default: 8080]
    --host <HOSTNAME>    🏨 The hostname used by the hot-reload server [default: 127.0.0.1]
    -o, --open <open>    🌐 Automagically open your browser on startup [default: false]
    -V, --version        🎬 Print version information

打开默认浏览器

只需传递--open标志，让cargo-markdown在启动时自动打开您的默认浏览器。

如果不传递--open，则不会自动打开浏览器。您可以自行浏览显示的url。这在您已经打开了预览网站的标签页但已关闭cargo-markdown时非常有用。当您重新打开cargo-markdown时，任何打开的标签页将在5秒内自动重新连接。

🧪 在移动设备上进行测试

您可以使用类似ngrok的工具打开一个公开url到您的本地预览站点，然后在您的移动设备（或任何其他可以访问互联网的设备）上连接到它。

一旦您在系统上安装了ngrok，请按照以下方式运行它

./ngrok http 8080

ngrok将显示一个指向您localhost:8080地址的公开URL。

现在只需运行cargo-markdown并传递ngrok提供的host。

cargo markdown readme.md --host 62cf2a5454d8.ngrok.io

现在您可以使用另一台机器或移动设备通过浏览器访问另一台设备上的crates.io模拟，并实现热重载，访问地址为：http://62cf2a5454d8.ngrok.io（或ngrok提供的任何地址）

注意：由于网站是通过互联网和代理而不是直接从localhost重新加载，因此通过ngrock的热重载可能较慢

❤️喜欢这个工具？

⭐星https://github.com/rrrodzilla/cargo-registry-preview

🐦关注https://twitter.com/rrrodzilla