Comments (8)
关于 code 标记,我能理解几位的意见和目前网站呈现出来的现状。
我相信类似的细节体验在我们的文档中甚至所有你在互联网能看得到的文档中还大量存在,我们确定翻译规范,一方面是权衡各方面利弊,另一方面是要保持一个可以长期有确定性的规范,同时在不产生关键问题和歧义的基础上尊重先入为主的观点。不然很容易在没有绝对对错的地方陷入无休止的讨论。希望大家能够理解这一点。🙏
综上所述,我觉得这里没有特别需要修改的必要。
另外这个议题其实和这个 issue 的标题有一些距离,如果大家仍觉得需要更多讨论,我建议单开一个 issue,不然大家会因为这个标题错过自己可能感兴趣的讨论或提供帮助的机会。
from docs-next-zh-cn.
@Jinjiang @Justineo
经过#78,以及#49 的讨论结果,现将 issue #78 讨论的结果调整如下:
已更新到 关于加粗和斜体格式的约定 wiki。
// 情况1:
**相对胜于晦涩。**例如,一个 `<BlogPost>` 组件例子比 `<CurrencyExchangeSettings>` 更好。 // vuepress 无法渲染
(调整为:)
**相对胜于晦涩**。例如,一个 `<BlogPost>` 组件例子比 `<CurrencyExchangeSettings>` 更好。 // 迁移句号有加粗符号右侧
// 情况2:
**你好,**世界 ==> **你好**,世界 (句号迁移到右侧)
(调整为:)
**你好,世界。** ==> **你好,世界。** (不影响渲染,保持原样)
讨论结束,现将 close 该 issue
from docs-next-zh-cn.
是不是方法1更为统一一点,个人感觉加粗对于标点的影响并不大
from docs-next-zh-cn.
关于符号的问题,我也想说一个,请看以下示例:
就是 code 标记 `` 的问题:
我们来看一个case
,渲染后我们双击选中
再来看第二个 case
吧,渲染后双击选中
第一个示例,标记左右都没有空格,双击选中之后自然而然就是【case】单词
第二个示例,标记左右都有空格,双击选中之后【case】的右边多了一个空格
诚然,根据一些书写规范,英文单词在中文之间建议在英文左右添加空格,以此保证可读性
但在 code 标记中,渲染出来的效果,左右已经有足够的空隙了
另外,我觉得有些开发者(包括我)习惯双击关键字,然后复制搜索或者用于其他地方,多了个空格造成了一丢丢困扰
当然,这一丢丢影响不算什么,这只是根据我个人的体验而提出的小问题
所以,我提议,在使用 code 标记时:
- 若标记左边是字母(包括数字),则加上空格(这其实是保持英文单词左右加上空格的书写规范)
- 标记左右遇到标点符号,无须加空格
- 标记左右都是中文,无须加空格
from docs-next-zh-cn.
上面讨论是一个有趣的体验改进,虽然与加粗符号的讨论不是一个专注的话题,但也是增强阅读、交互体验本身的内容,可以持续探讨。
刚才尝试改动为:仅标记左边空格,右边不空格,双击复制似乎没什么问题,但看起来很不协调。
(回复楼下:我想暂时将其添加为备忘录,我们目前依赖 zhlint 工具的排版规范,@zhenzhenChange 的建议可能对规范有“冲突”,在合适的时机再推出讨论是不是更好。我想先专注于文档质量和“添补”性质的讨论,我个人认为你的提议其实很有意义。)
from docs-next-zh-cn.
是的,仅左边加,而右边不加,首先在书写上不协调,然后实际效果上其实是左边宽了一些(标记本身的间距以及加上了一个空格)
from docs-next-zh-cn.
@veaba 没问题,你们先走流程
from docs-next-zh-cn.
关于加粗符号 (或强调符号),我的看法是在 markdown 解析出现问题的情况下再调整标点符号的位置。因为:
- 由于 markdown 本身语法的关系,这里要么是渲染不正确,要么是对原文产生了细微的调整 (即便是少强调了一个标点符号)。两者都应该尽量避免。
- 而且为了统一格式把整句话留一个标点符号在星号外面确实很奇怪,一定会引发更多的讨论和争议。
相同的留言在这里 #49 (comment)
from docs-next-zh-cn.
Related Issues (20)
- 翻译表述有误 HOT 5
- bug: 组件自闭合会导致后面的内容无法显示 HOT 1
- 开启生产环境模式 HOT 8
- vue3.2.12版本defineExpose返回的数组会被深度reactive化(数组内部的对象会变成proxy) HOT 1
- bug:
- Caveats 如何翻译的问题 HOT 7
- Vue支不支持在浏览器中直接运行vue单文件呢 HOT 1
- When I use Jump to the main content link function + vue - while on a router cannot jump to the main content HOT 1
- bug: 在vue3的组件中,父组件给子组件传入一个router-link的to的路径 ,子组件读取不到 HOT 1
- bug: [文档]渲染函数-创建组件-vnode可能错误 HOT 1
- bug: 修改响应式 property 的代码示例错误使用this HOT 4
- sleight-of-hand 是否翻译为 “微调” 比较合适呢? HOT 2
- 关于transition动画里的文档错误 HOT 2
- bug: 中文文档中自定义指令描述错误! HOT 4
- array-refs中的文案错误 HOT 1
- 有没有完整示例代码? HOT 1
- bug: vue3.2.29通过v-for显示component组件通过ref调用子组件方法时提示子组件方法为undefined
- bug: vue3.2.29通过v-for显示component组件通过ref调用子组件方法时提示子组件方法为undefined HOT 1
- 对于远端动态组建的api有支持吗
- 该版本文档停止更新,欢迎去新版文档贡献 HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docs-next-zh-cn.