blocks|key|432918|text|有很多方法:如果你使用的是Mac，可以使用Mou。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|432919|如果你想在浏览器中测试，你可以尝试StackEdit，正如@Aaron或Dillinger指出的那样，因为Notepag现在似乎已经停机了。就我个人而言，我使用Dillinger，因为它可以正常工作，并将我所有的文档保存在浏览器的本地数据库中。|432920|entityMap|0|LINK|mutability|MUTABLE|url|http://25.io/mou/|1|https://stackedit.io/|2|http://dillinger.io/|3|http://notepag.es/^0|L|3|0|0|H|9|1|10|9|2|1H|7|3|0^^$0|@$1|2|3|4|5|6|7|T|8|@]|9|@$A|U|B|V|1|W]]|C|$]]|$1|D|3|E|5|6|7|X|8|@]|9|@$A|Y|B|Z|1|10]|$A|11|B|12|1|13]|$A|14|B|15|1|16]]|C|$]]|$1|F|3|-4|5|6|7|17|8|@]|9|@]|C|$]]]|G|$H|$5|I|J|K|C|$L|M]]|N|$5|I|J|K|C|$L|O]]|P|$5|I|J|K|C|$L|Q]]|R|$5|I|J|K|C|$L|S]]]]

Many ways: If you're on a Mac, use <a href="http://25.io/mou/" rel="noreferrer">Mou</a>.

If you want to test in a browser, you could try <a href="https://stackedit.io/" rel="noreferrer">StackEdit</a>, as pointed out by @Aaron or <a href="http://dillinger.io/" rel="noreferrer">Dillinger</a> since <a href="http://notepag.es" rel="noreferrer">Notepag</a> seems to be down now. Personally I use Dillinger since it just works and saves all my documents in my browser's local database.

blocks|key|433011|text|这一点已经被证明是可靠的了：http://tmpvar.com/markdown.html|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|433012|entityMap|0|LINK|mutability|MUTABLE|url|http://tmpvar.com/markdown.html^0|E|V|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

This one has proven reliable for quite some time: <a href="http://tmpvar.com/markdown.html" rel="noreferrer">http://tmpvar.com/markdown.html</a>

blocks|key|647402|text|我通常直接在GitHub网站上编辑它，然后点击编辑窗口上方的“预览”。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|647403|也许这是这篇文章发布后添加的一个新功能。|647404|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|F|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|G|8|@]|9|@]|A|$]]|$1|D|3|-4|5|6|7|H|8|@]|9|@]|A|$]]]|E|$]]

I usually just edit it on the GitHub website directly and click "Preview" just above the editing window.

Perhaps that's a new feature that's been added since this post was made.

blocks|key|647439|text|在web中，使用Dillinger。太棒了。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|647440|entityMap|0|LINK|mutability|MUTABLE|url|http://dillinger.io/^0|8|9|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

In the web, use <a href="http://dillinger.io" rel="noreferrer">Dillinger</a>. It's awesome.

blocks|key|432955|text|你可能想看看这个：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|432956|https://github.com/kristjanjansen/md2html|offset|length|432957|entityMap|0|LINK|mutability|MUTABLE|url^0|0|0|15|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|N|8|@]|9|@$D|O|E|P|1|Q]]|A|$]]|$1|F|3|-4|5|6|7|R|8|@]|9|@]|A|$]]]|G|$H|$5|I|J|K|A|$L|C]]]]

You may want to take a look at this one:

<a href="https://github.com/kristjanjansen/md2html" rel="nofollow">https://github.com/kristjanjansen/md2html</a>

blocks|key|433107|text|只要在网上搜索一下，就会给出一个答案：https://stackedit.io/|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|433108|entityMap|0|LINK|mutability|MUTABLE|url|https://stackedit.io/^0|J|L|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

Just searching the web gives many heres one:
<a href="https://stackedit.io/" rel="nofollow">https://stackedit.io/</a>

blocks|key|647725|text|我使用的是markdownlivepreview预览：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|647726|https://markdownlivepreview.com/|offset|length|647727|它非常简单，简单，快速。|647728|entityMap|0|LINK|mutability|MUTABLE|url^0|0|0|W|0|0|0^^$0|@$1|2|3|4|5|6|7|O|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|P|8|@]|9|@$D|Q|E|R|1|S]]|A|$]]|$1|F|3|G|5|6|7|T|8|@]|9|@]|A|$]]|$1|H|3|-4|5|6|7|U|8|@]|9|@]|A|$]]]|I|$J|$5|K|L|M|A|$N|C]]]]

I am using markdownlivepreview: 
<a href="https://markdownlivepreview.com/" rel="nofollow noreferrer">https://markdownlivepreview.com/</a>
It is very easy, simple and fast.

blocks|key|647555|text|如果你正在使用Pycharm+(或者其他Jetbrains集成开发环境，如Intellij，RubyMine，PHPStorm等)，你的集成开发环境中有多个支持Markdown的免费插件，它们允许在编辑时进行实时预览。Markdown+Navigator插件相当不错。如果您在集成开发环境中打开一个.md文件，最新版本将提供安装支持插件并向您显示列表。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|647556|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

If you're using Pycharm (or another Jetbrains IDE like Intellij, RubyMine, PHPStorm, etc), there are multiple free plugins for Markdown support right in your IDE that allow real-time preview while editing. The Markdown Navigator plugin is quite good. If you open an .md file in the IDE, recent versions will offer to install supporting plugins and show you the list.

blocks|key|433342|text|使用Jupyter+Lab。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|433343|要安装Jupyter+Lab，请在您的环境中键入以下内容：|433344|pip+install+jupyterlab|code-block|syntax|javascript|433345|安装后，浏览到您的markdown文件的位置，右键单击该文件，选择“打开方式”，然后单击"Markdown+Preview“。|433346|entityMap|0|LINK|mutability|MUTABLE|url|https://github.com/jupyterlab/jupyterlab^0|2|B|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|U|8|@]|9|@$A|V|B|W|1|X]]|C|$]]|$1|D|3|E|5|6|7|Y|8|@]|9|@]|C|$]]|$1|F|3|G|5|H|7|Z|8|@]|9|@]|C|$I|J]]|$1|K|3|L|5|6|7|10|8|@]|9|@]|C|$]]|$1|M|3|-4|5|6|7|11|8|@]|9|@]|C|$]]]|N|$O|$5|P|Q|R|C|$S|T]]]]

Use <a href="https://github.com/jupyterlab/jupyterlab" rel="nofollow noreferrer">Jupyter Lab</a>.

To install Jupyter Lab, type the following in your environment:

<pre><code>pip install jupyterlab
</code></pre>

After installation, browse to the location of your markdown file, right-click the file, select "Open With" then click "Markdown Preview".

blocks|key|433506|text|我发现markdownlivepreview.com非常接近于普通的GitLab标记。其他查看器对命令的解释与GitLab略有不同。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|433507|entityMap|0|LINK|mutability|MUTABLE|url|https://markdownlivepreview.com/^0|3|N|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

I have found that <a href="https://markdownlivepreview.com/" rel="nofollow noreferrer">markdownlivepreview.com</a> is pretty close to vanilla GitLab markdown.
Other viewers interpreted commands slightly differently than GitLab does.

blocks|key|433627|text|我只是创建了一个"feature“分支，并将其推送到github，在那里我进行了更改，这些更改将变得与它们在github中的外观完全相同。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|433628|然后，当我感到满意时，我会重新建立到main的基础，或者向main发出一个pull请求，无论您使用的是哪一个进程。|433629|使用git时，您很少需要在本地进行测试，除非您的存储库位于公司防火墙之后，或者需要脱机工作。|433630|在这种情况下，Atom和VScode都有不错的Markdown渲染器，不足以显示您的更改在github上的外观，但足以查看您的更改是否朝着正确的方向发展。|433631|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|J|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|K|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|L|8|@]|9|@]|A|$]]|$1|F|3|G|5|6|7|M|8|@]|9|@]|A|$]]|$1|H|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|I|$]]

I just create a &quot;feature&quot; branch and push it to github where I make changes, which become visible exactly how they will look in github.
Then, when I'm satisfied, I rebase back to main or do a pull request to main, whichever process you happen to be using.
You rarely need to test locally when using git, unless your repository is behind a corp firewall, or need to work offline.
In such cases, both Atom and VScode have decent Markdown renderers, not good enough to show how your changes will look on github, but good enough to see if your changes are going in the right direction.

blocks|key|433245|text|对于那些希望在他们的iPads上进行开发的人，我喜欢Textastic。从云中下载文档后，可以在没有internet连接的情况下编辑和预览README.md文件。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|433246|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

For those who wish to develop on their iPads, I like Textastic. You can edit and preview the README.md files without an internet connection, once you have downloaded the document from the cloud.

I am writing a readme for my github project in the .md format. Is there a way can I test what my readme.md file will look like before committing to github?

How can I test what my readme.md file will look like before committing to github?

集成开发环境

数据库

防火墙

GitHub

我正在为我的github项目编写.md格式的自述文件。有没有办法在提交到github之前测试我的readme.md文件是什么样子的？

问在提交到github之前，我如何测试我的readme.md文件会是什么样子？
EN

回答 12

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问在提交到github之前，我如何测试我的readme.md文件会是什么样子？EN

回答 12

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问在提交到github之前，我如何测试我的readme.md文件会是什么样子？
EN