mdx源文件中如何添加注释行

VimVim

+ i9 E# R- q' X# U/ Q' j为了让Vim更好地编辑mdx源文件，我需要指定源文件为html格式，从而可以正确加亮语法，但我又不想将文件后缀名txt改为html，否则用mdxbuilder制作mdx时又得改回txt。
  D5 Z+ l  l5 R% t
Vim可以通过在文件中指定文件类型，从而识别之，如：
' U$ M$ D3 [- ~, J$ z/* vim: set filetype=html : */

但毕竟注释文件与源文件的规定有所不同，既不是词条也不是正文。
6 i! s  o3 |% B2 F8 h经测试：
! V- v4 V( T4 I2 _) d" d- V+ i9 f6 D. \1、若将注释行放在txt源文件最前面，mdxbuilder会将该注释行当做词条；
2 M- q/ j2 }- ?6 C; a  h( G$ U2、若将注释行放在txt源文件最后面，mdxbuilder会报错；
) m9 ?. e6 F8 Z8 [7 y
" p$ R2 Z+ G2 S2 z暂时解决方案有如下两个：
, p+ x: e. c& x  Z. S4 Y" _$ p) z方案1、将Vim注释当做一个多余的词条，缺点是这并不是真正的词典词条，如：
/* vim: set filetype=html : */
</>
- y7 P1 i9 G+ d/ e+ a: S7 h方案2、将Vim注释行前后包装为HTML注释，并嵌入某一个词条的正文，缺点是，这个注释与该词条没有任何关系，如
/ j2 A0 z( q; }+ I; M# P<!-- /* vim: set filetype=html : */ -->

# e0 F+ C3 @' c5 v不知道各位是否有更好的解决方案？或者MDX源文件有自己的注释语法？
$ V1 d1 x% T/ S# X9 v. Q- ^

VimVim

若有人能够将Vim的HTML syntax文件转换为MDX源文件syntax文件，那就完美了

我就一句话，mdxbuilder制作mdx时不需要改回txt。只能帮到这里。看你自己的选择。

henices

看了老半天，终于有点看懂了。楼主的主要问题有几个：

, \* L* R: o1 L6 o1. 如何 让 vim 浏览 txt 后缀文件时，使用 html 语法高亮问题
- e) L* n6 {4 N* Z, J
这个直接输入命令不就好了  进入 normal 模式后 :set ft=html  
为什么要写在 mdx 的 txt 里呢

/ O( f9 e) R/ E# b6 `4 G2. mdx 的注释语法
# ^8 E- m2 T8 J4 i
5 m, O8 x8 z4 I, g不论是用那个软件，最终都是当成 html 解析的，所以正确的注释语法是 <!-- -->
5 k7 ^2 v8 x6 s& [2 l; N) Y
# b- `0 w$ ]6 Y3 m3. 搞一个 mdx 的语法高亮文件

同上就是应该是用html 高亮啊， 唯一不同的是 </> 个人感觉影响不大

2 N: z; f& _, A% r
4 A& m7 @9 v: {3 ~最后，如果 mdx 的 txt 文件很大的， 加载语法高亮简直就是一个灾难，
不信打开一个1G 的 mdx 的 txt 加载 html 语法高亮试试。

VimVim

bbs 发表于 2018-12-25 11:47
2 T- C( t  {, X5 S; T" H  O我就一句话，mdxbuilder制作mdx时不需要改回txt。只能帮到这里。看你自己的选择。 ...

感谢各位的解答，我知道有很多变通解决方案，但总觉得不是最佳。
- `; [+ u" J& J% j: r& u0 B+ M
mdxbuilder的选择框里只能选择txt，除非我们不用选择框，而是直接写源文件地址。
更好的方案是，mdxbuilder的选择框里可以选择任意文件格式，而不限定txt。

、

VimVim

henices 发表于 2018-12-25 12:00
看了老半天，终于有点看懂了。楼主的主要问题有几个：

! L  f8 a" ?3 Z1. 如何 让 vim 浏览 txt 后缀文件时，使用 html 语 ...

您的理解很准确！对于您提到的：
4 q( }3 q, ^. A0 G
% v- |# i5 @( |: V1 R0 _0 V1、:set filetype=html确实可以，但每次打开都得来一次，感觉比较麻烦，毕竟修订源文件可能来来回回好多次。
+ N4 P) j% a/ |" P
2、采用HTML注释，只能加入到某个词条，而不是文件最开始或最后，总觉得不舒服（癌症，得改！）
( `  f* P9 s& t2 Z( i4 e% m5 l
! U. W4 D0 y7 p1 J3、搞一个mdx的语法高亮文件：这是我最希望的，但限于技术水平不知道怎么搞……
, V/ K4 Y# }- v; j" X5 ^
4、关于语法高亮带来的性能问题：对于大文件性能确实是一个问题，但我之所以需要识别格式，是为了能够使用Vim基于文件格式的其他插件功能，比如matchit的HTML标签配对等，这有助于借助vim的宏命令等实现一些自动化批量操作。
9 w  M' {5 a- x

henices

VimVim 发表于 2018-12-25 13:12
% i: h1 x6 d( o8 R* \您的理解很准确！对于您提到的：

1、:set filetype=html确实可以，但每次打开都得来一次，感觉比较麻烦 ...

不难，我就写过， 给你参考一下

1 u8 W% \" B- h7 Ahttps://github.com/henices/vim-nbin/blob/master/syntax/nbin.vim

VimVim

henices 发表于 2018-12-25 15:56
不难，我就写过， 给你参考一下

8 V- u0 K% {: ~https://github.com/henices/vim-nbin/blob/master/syntax/nbin.vim ...

: O8 V7 [% b* Y0 U, D感谢！目前对我还是很有难度，继续学习学习！

spoony1971

VimVim 发表于 2018-12-25 13:12
$ L0 F: Y1 C; I您的理解很准确！对于您提到的：
$ t0 ~, N% j/ [7 ]" h3 K! y3 k( r
1、:set filetype=html确实可以，但每次打开都得来一次，感觉比较麻烦 ...

能处理超大文件语法高亮的只有vis了。

VimVim

我最终的解决方案是在mdx源文件最前面添加如下三行：

% {6 F0 g  A0 T# k<!-- mdx modeline for Vim-->
- m- N8 P+ |% C2 R3 N/ o3 W. p<!-- vim: set filetype=html : -->
0 N9 i& O+ _* p9 _0 ?</>