问题标签 [markdown]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
documentation - 您的团队使用什么工具来编写用户手册?
基本要求是:
- 人类可读/文本格式(便于版本控制)
- 在线(用于协作)
- 轻松格式化(markdown ok,html 太多了)
- 严格的格式(所以作者不会发明新类型的标题、项目符号等)
- 可导出为 PDF、HTML
- 轻松备份和部署(因此我们可以作为只读版本“部署”到客户站点)
我们正在考虑使用某种 wiki 引擎,但它需要使用文件进行存储或对客户有其他“部署”方式,并且易于安装/维护。此外,它必须是免费/便宜的(confluence 太贵了)
有什么建议么?
编辑:我不是在寻找记录代码的工具,我们已经使用 Sandcastle 进行了介绍。
outlook - 展望中的降价
因为这不是那种接受wiki的公司,所以我们倾向于通过outlook进行大量的交流。通过它发送代码片段很痛苦。有什么方法可以让我们在这里得到降价的东西,但是在前景中?
macos - 如何制作 Spotlight 索引 Markdown 文件?
我通常对降价文档使用 .markdown 或 .md 扩展名。不幸的是,除非它们具有 .txt 文件扩展名,否则 Spotlight 拒绝为它们编制索引。
我已经看到了一个可能的解决方案,涉及在 textmate 博客上编辑 Info.plist 文件。有没有更好的办法?
更新:我刚刚发现了 Markdown 文件的 QuickLook 生成器,它增加了聚光灯支持和漂亮的 HTML 快速预览预览。这是一种享受!
ruby - 更好的 ruby markdown 解释器?
我正在尝试找到可以在 rakefile 中使用的降价解释器类/模块。
到目前为止,我已经找到了 maruku,但我对 beta 版本有点警惕。
有人对maruku有任何问题吗?或者,您知道更好的选择吗?
javascript - 关于实现 Stack Overflow 风格注释的想法
我非常喜欢 Stack Overflow 评论 UI,我正在考虑在我自己的网站上实现同样的功能。我查看了代码,看起来这里的主要工具是WMD,而 JQuery TextArea Resizer起到了辅助作用。
WMD 在客户端将 Markdown 转换为 HTML。这非常好,因为它有助于预览,但是在将其发送到服务器时遇到了挑战。如果出现验证错误(比如用户在评论表单的其他部分输入了无效的电子邮件地址,或者他可能没有输入他的姓名),那么服务器会通过重新显示带有错误消息的表单和预先填充的表单字段。只是现在评论文本是 HTML,而不是 Markdown,因为服务器甚至从未见过 Markdown。但我希望它是 Markdown,因为这是用户输入的内容。
这里有什么想法吗?
我考虑了各种想法:
- 进行服务器端HTML 到 Markdown 的转换。对这个想法并不那么兴奋。从 Markdown 转换为 HTML 再转换回 Markdown 似乎很笨拙,作为用户,当软件重新格式化我的文本/代码时,我总是觉得它很烦人。
- 客户端验证(以增强服务器端验证,我当然会保留)。尽管目前我在评论表单上使用 reCAPTCHA,但这似乎是一个合理的方向,这意味着我至少需要将 reCAPTCHA 部分发布到服务器。
- 丢失 WMD 并使用MarkdownJ将 Markdown 转换为服务器上的 HTML。我需要寻找其他一些机制来完成我想要保留的预览功能。
理想情况下,除了 HTML 之外,还有一些方法可以获取文本的 Markdown 版本并将其提交到服务器,但我还不足以知道这是否是一个真正的可能性。
任何建议表示赞赏。
ruby-on-rails - 截断降价?
我有一个 Rails 站点,其中的内容是用 markdown 编写的。我希望显示每个片段,并带有“阅读更多..”链接。
我该怎么做?例如,简单地截断原始文本是行不通的。
理想情况下,我希望允许作者(可选)插入一个标记以指定用作“片段”的内容,如果不是,则需要 250 个单词,并附加“...” - 例如..
该标记可以被认为是一个 EOF 标记(在显示完整文档时可以忽略它)
我正在使用maruku进行 Markdown 处理(RedCloth 非常偏向于 Textile,BlueCloth 非常有问题,我想要一个排除 peg-markdown 和 RDiscount 的原生 Ruby 解析器)
或者(因为无论如何 Markdown 都被翻译成 HTML)正确截断 HTML 是一种选择——尽管最好不要markdown()
整个文档,只是为了得到前几行。
所以,我能想到的选项是(按优先顺序)..
- 向 maruku 解析器添加一个“截断”选项,它只会解析前 x 个单词,或者直到“摘录”标记。
- 编写/查找与解析器无关的 Markdown truncate'r
- 编写/查找智能 HTML 截断函数
xss - 验证用户输入字段时不允许使用 HTML 表格的原因是什么?
我正在写一点 wiki 并浏览我所有的语法高亮选项。在 wiki 语法 (mediawiki) 和 markdown + 白名单标签之间进行辩论。我想我更喜欢后者,但我认为我的用户需要表格。为什么 Stackoverflow 上不允许使用表格?
html - 即时渲染标记或存储 html?
在处理用户输入的标记(例如 wiki 或 markdown)时对您有用的任何建议。我有 CPU 和数据库空间成本,所以我不确定该走哪条路。
将标记存储在数据库中并为每个页面浏览呈现到服务器上的 html。(更少的数据库空间,但更多的 CPU 使用率)
将标记存储在数据库中并使用 javascript 在客户端上呈现为 html。(可能更难实现)
仅将呈现的 html 存储在数据库中并在需要编辑时转换回标记。(同样,实施起来可能很棘手)。
将 html 和标记都存储在数据库中。(数据库空间翻倍)。
别的东西。
(我正在使用 MFC 和 Linqtosql)。