可发布的markdown
有很多理由喜欢Markdown,Markdown是一种简单易用的语言,具有易于学习的语法,可以与任何文本编辑器一起使用。 使用Pandoc之类的工具,您可以将Markdown文本转换为多种流行的格式 ,包括HTML。 您还可以在Web服务器中自动执行该转换过程。 TimoDörr创建HTML5和JavaScript应用程序MDwiki可以获取一堆Markdown文件,并在浏览器请求时将它们转换为网站。 MDwiki网站包含操作指南和其他信息,以帮助您入门:
![MDwiki网站入门 MDwiki site getting started](https://opensource.com/sites/default/files/uploads/1_-_mdwiki_screenshot.png)
Mdwiki网站的外观。
在Web服务器中,一个基本的MDwiki站点如下所示:
该站点的网络服务器文件夹的外观。
我为此项目重命名了MDwiki HTML文件START.HTML
。 还有一个Markdown文件用于处理导航,还有一个JSON文件用于保存一些配置设置。 其他所有内容都是网站内容。
虽然MDwiki固定了整个网站的设计,但内容,样式和页面数却没有。 您可以在MDwiki站点上查看由MDwiki生成的不同站点的选择。 可以说,MDwiki网站缺乏Web设计师可以实现的视觉吸引力,但是它们具有功能性,用户应该在其简单外观与创建和编辑它们的速度以及便捷性之间取得平衡。
Markdown具有多种口味,可扩展稳定的核心功能以用于不同的特定目的。 MDwiki使用GitHub风格的Markdown ,它为流行的编程语言添加了诸如格式化的代码块和语法突出显示等功能,使其非常适合制作程序文档和教程。
MDwiki还支持所谓的“ gi头”,它增加了额外的功能,例如嵌入YouTube视频内容和显示数学公式。 如果您需要将它们用于特定项目,则值得探讨。 我发现MDwiki是创建技术文档和教育资源的理想工具。 我还发现了一些可能不会立即显现出来的花招和技巧。
当部署在Web服务器中时,MDwiki可与任何现代Web浏览器一起使用。 但是,如果使用Mozilla Firefox访问MDwiki,则不需要Web服务器。 大多数MDwiki用户将选择在Web服务器上部署完成的项目,以避免排除潜在用户,但是开发和测试可以仅使用文本编辑器和Firefox来完成。 任何现代浏览器都可以读取已加载到Moodle虚拟学习环境(VLE)中的完整MDwiki项目,这在教育环境中可能很有用。 (其他VLE软件也可能如此,但是您应该对此进行测试。)
MDwiki的默认配色方案并不适合所有项目,但您可以将其替换为从Bootswatch.com下载的另一个主题。 为此,只需在编辑器中打开MDwiki HTML文件,取出extlib/css/bootstrap-3.0.0.min.css
代码,然后插入下载的Bootswatch主题。 还有一个MDwiki头,允许用户选择Bootswatch主题来替换MDwiki在其浏览器中加载后的默认主题。 我经常与有视觉障碍的用户一起工作,他们倾向于使用高对比度主题,在深色背景上带有白色文本。
![具有Bootswatch Superhero主题的MDwiki屏幕 MDwiki screen with Bootswatch Superhero theme](https://opensource.com/sites/default/files/uploads/3_-_mdwiki_bootswatch_superhero.png)
使用Bootswatch Superhero主题的MDwiki屏幕
MDwiki,Markdown文件和静态图像可以用于许多目的。 但是,有时您可能希望包括JavaScript幻灯片或反馈表。 Markdown文件可以包含HTML代码,但是将Markdown与HTML混合会引起混淆。 一种解决方案是在单独HTML文件中创建所需的功能,并将其显示在带有iframe标记的Markdown文件中。 我是从Twine互动小说引擎的支持网站Twine Cookbook那里得到这个想法的。 《 Twine Cookbook》实际上并未使用MDwiki,但是将Markdown和iframe标签结合在一起可提供广泛的创意可能性。
这是一个例子:
该HTML将在Markdown文件中显示由Twine交互式小说引擎创建HTML页面。
<iframe height="400" src="sugarcube_dungeonmoving_example.html" width="90%"></iframe>
MDwiki生成的站点中的结果如下所示:
简而言之,MDwiki是一个出色的小型应用程序,可以很好地实现其目的。
翻译自: https://opensource.com/article/18/8/markdown-html-publishing
可发布的markdown