Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 2.11 KB

important-notes.zh.md

File metadata and controls

22 lines (15 loc) · 2.11 KB

注意事项

English | 简体中文

在 XenForo 平台上,并没有对 Markdown 的原生支持,也没有用 API 写成的类似插件,所以 xenforo-markdown 诞生了。xenforo-markdown 作为一种另类的方式,能让你的用户用上 Markdown,但实现起来绝对没有那么优雅。

也就是说,尽管 xenforo-markdown 可以把 Markdown 文本(大多数时候)正确地渲染出来,背后的原理可能是一团乱麻。你也可以通过日常渲染的速度、稳定性、漏洞等方面感受到这一点。

因而很显然也很有必要在这里给出注意事项,从而让你能够提前为某些后果做好心理准备。

xenforo-markdown 不会导致数据的丢失,因为一切操作都是在前端进行的,这一点可以放心。

  • 可能你要永远用下去。 所有的内容都必须用 [MD] 包裹,但万一你不打算继续用这个插件了呢?所有的内容都会现出原形来。如果你的大部分用户都很爱用 Markdown 的话,这些裸露的内容对于新人来说无疑是很诡异的景象。
  • 不是要写 Markdown 的话就不要把 [MD] 搬出来。 这是渲染方式所导致的一项要求。[MD][/MD] 只能用来包你的内容(不能是空的),任何其它的用法都有可能把你的内容搞乱。如果你确实要用这东西做点什么,比如说举些例子,请确保用转义来避免麻烦,例如这样写:\[MD\]\[/MD\]
  • 许多内容是 MineBBS 定制的。 然而短期内并没有修复这一点的打算。这导致如果要在你自己的网站上使用的话,可能要进行一些魔改。定制的部分包括但不仅限于:
    • 启用渲染的页面 - 只渲染地址中包含 thread/resource/ 等字样的页面
    • 样式 - 取决于 MineBBS 正在用的主题。
    • 渲染对象元素类名 - 取决于 MineBBS 正在用的主题。比如 .bbWrapper 代表放用户发的内容的地方。
    • 更多见 xf-markdown.ts
  • 未完待续。

如果上述对你而言都能接受,那么 xenforo-markdown 开箱即用!