当前位置: 首页 > 科技观察

使用MDwiki

时间:2023-03-14 11:51:13 科技观察

将Markdown发布到HTML使用这个有用的工具从Markdown文件创建一个基本的网站。喜欢Markdown的原因有很多,它是一种简单的语言,语法易于学习,并且适用于任何文本编辑器。使用像Pandoc这样的工具,您可以将Markdown文本转换为各种流行的格式,包括HTML。您还可以在Web服务器中自动执行转换过程。由TimoD?rr创建的名为MDwiki的HTML5和JavaScript应用程序可以在浏览器请求时将一堆Markdown文件转换为网站。MDwiki站点包含操作指南和其他信息以帮助您入门:MDwiki站点的外观。在Web服务器内部,一个基本的MDwiki站点如下所示:站点的Web服务器文件夹看起来像什么我将此项目的MDwikiHTML文件重命名为START.HTML。还有一个处理导航的Markdown文件和一个保存一些配置设置的JSON文件。其他一切都是网站内容。虽然网站的整体设计由MDwiki确定,但内容、样式和页面数量却没有。您可以在MDwiki站点查看由MDwiki生成的一系列不同站点。公平地说,MDwiki网站缺乏网页设计师可以实现的视觉吸引力——但它们是实用的,用户应该在其简单的外观与创建和编辑它们的速度和便利性之间取得平衡。Markdown有不同的风格,可以针对不同的特定目的扩展稳定的核心功能。MDwiki使用GitHub风格的Markdown,它为流行的编程语言添加了格式化代码块和语法高亮等功能,使其成为生成程序文档和教程的理想选择。MDwiki还支持“gimmick”,它添加了额外的功能,例如嵌入YouTube视频和显示数学方程式。如果您在某些项目中需要它们,这些值得探索。我发现MDwiki是创建技术文档和教育资源的理想工具。我还发现了一些可能不会立即显现的技巧和窍门。当部署在网络服务器中时,MDwiki可以与任何现代网络浏览器一起使用。但是,如果您使用MozillaFirefox访问MDwiki,则不需要Web服务器。大多数MDwiki用户会选择将完整的项目部署在Web服务器上,以避免排斥潜在用户,但开发和测试仅使用文本编辑器和Firefox即可完成。加载到Moodle虚拟学习环境(VLE)中的完整MDwiki项目可以通过任何现代浏览器阅读,这在教育环境中非常有用。(其他VLE软件可能也是如此,但你应该测试一下。)MDwiki的默认配色方案并不适合所有项目,但你可以用从Bootswatch.com下载的其他主题替换它。为此,只需在编辑器中打开MDwikiHTML文件,找到extlib/css/bootstrap-3.0.0.min.css,然后插入下载的Bootswatch主题。还有一个MDwiki噱头,允许用户在浏览器中加载MDwiki后选择一个Bootswatch主题来替换默认主题。我经常与视障用户一起工作,他们倾向于喜欢深色背景上带有白色文本的高对比度主题。使用BootswatchSuperhero主题的MDwiki页面MDwiki、Markdown文件和静态图像可用于多种用途。但是,有时您可能希望包含JavaScript幻灯片或反馈表。Markdown文件可以包含HTML代码,但是将Markdown与HTML混合使用会让人感到困惑。一种解决方案是在单独的HTML文件中创建所需的功能,并将其显示在带有iframe标记的Markdown文件中。我的想法来自TwineCookbook,这是Twine交互式小说引擎的支持站点。TwineCookbook实际上并不使用MDwiki,但结合Markdown和iframe标签开辟了广泛的创作可能性。下面是一个示例:此HTML将显示由Twine交互式小说引擎在Markdown文件中创建的HTML页面。MDwiki生成的站点结果如下:简而言之,MDwiki是一个很棒的小应用程序,很好地实现了它的目的。