vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Auto merge of #3000 - micbou:update-docs, r=bstaletic

Browse Source 
[READY] Write table in HTML in docs

The tools we are using to convert our `README.md` file into Vim docs ([html2vimdoc](https://github.com/xolox/vim-tools)) and into HTML for the YCM website ([Python-Markdown](https://python-markdown.github.io/#features)) don't support GitHub Markdown tables. We need to write the table in HTML and use @puremourning's changes to [html2vimdoc](https://github.com/xolox/vim-tools) which adds support for simple HTML tables. The result is not perfect but still better than what we currently have.

The html2vimdoc version used to generate the Vim docs can be found in [this branch](https://github.com/micbou/vim-tools/tree/ycm).

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/3000)
<!-- Reviewable:end -->
This commit is contained in:
zzbot 2018-04-26 14:57:04 -07:00 committed by GitHub
commit 07c186078f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 51 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -861,12 +861,45 @@ match uppercase letters in the completion strings (the lowercase letters still
match both). On top of that, a letter with no diacritic marks will match that match both). On top of that, a letter with no diacritic marks will match that
letter with or without marks: letter with or without marks:
| matches | foo | føo | fOo | fØo | <table>
|---------|-----|-----|-----|-----| <tbody>
| **foo** | ✔️ | ✔️ | ✔️ | ✔️ | <tr>
| **føo** | ❌ | ✔️ | ❌ | ✔️ | <th>matches</th>
| **fOo** | ❌ | ❌ | ✔️ | ✔️ | <th>foo</th>
| **fØo** | ❌ | ❌ | ❌ | ✔️ | <th>føo</th>
<th>fOo</th>
<th>fØo</th>
</tr>
<tr>
<th>foo</th>
<td>✔️</td>
<td>✔️</td>
<td>✔️</td>
<td>✔️</td>
</tr>
<tr>
<th>føo</th>
<td>❌</td>
<td>✔️</td>
<td>❌</td>
<td>✔️</td>
</tr>
<tr>
<th>fOo</th>
<td>❌</td>
<td>❌</td>
<td>✔️</td>
<td>✔️</td>
</tr>
<tr>
<th>fØo</th>
<td>❌</td>
<td>❌</td>
<td>❌</td>
<td>✔️</td>
</tr>
</tbody>
</table>
Use the TAB key to accept a completion and continue pressing TAB to cycle Use the TAB key to accept a completion and continue pressing TAB to cycle
through the completions. Use Shift-TAB to cycle backwards. Note that if you're through the completions. Use Shift-TAB to cycle backwards. Note that if you're

15
doc/youcompleteme.txt
View File

@ -1117,9 +1117,18 @@ uppercase letters in the completion strings (the lowercase letters still match
both). On top of that, a letter with no diacritic marks will match that letter both). On top of that, a letter with no diacritic marks will match that letter
with or without marks: with or without marks:
| matches | foo | føo | fOo | fØo | |---------|-----|-----|-----|-----| | ---------------------------------------------
**foo** | ✔️ | ✔️ | ✔️ | ✔️ | | **føo** | ❌ | ✔️ | ❌ | ✔️ | | **fOo** | ❌ | ❌ | | _matches_ | _foo_ | _føo_ | _fOo_ | _fØo_ |
✔️ | ✔️ | | **fØo** | ❌ | ❌ | ❌ | ✔️ | ---------------------------------------------
| _foo_ | ✔️ | ✔️ | ✔️ | ✔️ |
---------------------------------------------
| _føo_ | ❌ | ✔️ | ❌ | ✔️ |
---------------------------------------------
| _fOo_ | ❌ | ❌ | ✔️ | ✔️ |
---------------------------------------------
| _fØo_ | ❌ | ❌ | ❌ | ✔️ |
---------------------------------------------
Use the TAB key to accept a completion and continue pressing TAB to cycle Use the TAB key to accept a completion and continue pressing TAB to cycle
through the completions. Use Shift-TAB to cycle backwards. Note that if you're through the completions. Use Shift-TAB to cycle backwards. Note that if you're