docs icon indicating copy to clipboard operation
docs copied to clipboard

在文档标题下增加自定义标签,便于用户搜索

Open myleslee opened this issue 10 years ago • 8 comments

在标题下方增加对用户更熟悉的关键字(标签),帮助用户更快地定位内容。前后对比效果如下:

screen shot 2015-10-23 at 17 29 09
screen shot 2015-10-23 at 17 28 17

示例链接:https://leancloud.cn/docs/realtime_guide-ios.html#群聊

## 群聊

对于多人同时参与的固定群组,我们有成员人数限制,最大不能超过 500 人。对于另外一种多人聊天的形式,譬如聊天室,其成员不固定,用户可以随意进入发言的这种「临时性」群组,后面会单独介绍。

请前端工程师设计好 CSS 和 HTML tag,文档写作者在 md 文档中加入标签。

该标签没有超链接,只是普通文字。

另外请考虑当标签较多时,折行显示时不要交叠在一些。

myleslee avatar Oct 23 '15 09:10 myleslee

@sunchanglong @sparanoid

myleslee avatar Oct 23 '15 09:10 myleslee

@sunchanglong 我们有类似于 Jekyll 的 front matter 的设定吗?这样 tag 比较好维护:http://jekyllrb.com/docs/frontmatter/

sparanoid avatar Oct 23 '15 16:10 sparanoid

front matter 的 tag 是文章级别的,达叔截图上看这些 tag 是段落级别的。

leeyeh avatar Oct 24 '15 16:10 leeyeh

front matter 的 tag 是文章级别的,达叔截图上看这些 tag 是段落级别的。

感觉这样子并不好维护,另外会变成非标准的 markdown 格式,在 GitHub web 或其他 md 编辑器上查看可能会出现问题

sparanoid avatar Oct 26 '15 05:10 sparanoid

还好,不会是到处都是。我想最简单的形式是这样:

<div class="tags">
  <ul>
    <li>QQ</li>
    <li>私信</li>
    <li>微信</li>
  </ul>
</div>

前端渲染还需要加 markup 的话就用 JS 吧,比如 $(".tags>li").each(...)

目前渲染引擎不支持 HTML 内嵌 MD,所以只能全用 HTML:

<div class="tags" markdown="1">
- QQ
- 私信
- 微信
</div>

当前文档里也有 HTML 和 MD 混用的地方,特别是涉及到 table。因为有些写法 MD 不支持,比如单元格内再加入列表,这时只能用 HTML 的 UL、OL 来写(不复杂的 HTML 代码在 GitHub web 或其他 md 编辑器上可正常渲染)。

myleslee avatar Oct 26 '15 06:10 myleslee

需要列下这样做的目的,以及有了tag之后如何使用,对使用者看来,如何发现这些段落级别的tag。 直观上感觉段落级 tag 很难抽象,也比较琐碎,难以维护,段落也太多。 标题本身就是一种抽象,tag也是抽象,tag可以想象成为精简的标题,只不过很多时候不方便抽象成tag才变成一个标题的,这里从概念到实际展现应该有很多重叠。

sunchanglong avatar Oct 28 '15 02:10 sunchanglong

增加tag是希望用户在搜索文档时更能准确地定位到内容。 现在文档中存在一个问题是: 我们官方对一件事物的描述,和用户对一件事物的描述,语言表达不一致。 例如: 官方文档中的单聊:用户称其为私聊\一对一聊天 实时通信:用户称其为即时通信 消息:用户称其为历史记录 复合查询:用户称其为“or查询”

nicecui avatar Oct 28 '15 06:10 nicecui

这事儿还有下文么= = 这个功能我去年 6 月提的。。。。。。都快 1年了。。。

wujun4code avatar Apr 12 '16 04:04 wujun4code