https://github.com/thjbdvlt/markdown-polyphony.vim

markdown syntax for vim, focused on academic writings
https://github.com/thjbdvlt/markdown-polyphony.vim

academic-writing markdown pandoc syntax-highlighting vim

Last synced: about 1 month ago
JSON representation

markdown syntax for vim, focused on academic writings

• Host: GitHub
• URL: https://github.com/thjbdvlt/markdown-polyphony.vim
• Owner: thjbdvlt
• License: mit
• Created: 2024-05-16T07:19:12.000Z (8 months ago)
• Default Branch: sea
• Last Pushed: 2024-10-17T12:39:16.000Z (3 months ago)
• Last Synced: 2024-10-19T12:25:41.319Z (3 months ago)
• Topics: academic-writing, markdown, pandoc, syntax-highlighting, vim
• Language: Vim Script
• Homepage:
• Size: 265 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
extended markdown syntax for vim, based on [pandoc](https://pandoc.org/MANUAL.html#pandocs-markdown).

- inline quotes

- parentheses

- comments:

    - comments with `,,`

    - missing developpement with `...` (beginning of line)

    - important comment with `!!` (beginning of line)

- ...

the repository also contains a simple bash script to remove these comments (e. g. for pandoc).

quotes and parentheses

----------------------

quotes and parentheses, of course, are not part of _markdown syntax_. these are more like _semantic highlights_.

why that? because i want _inline quotes_ to be the same color as _block quote_ because they play the same role, they have the same kind of difference with the sentences that i write: one color for sentences i wrote, one color for sentences i quote.

this also make me see quickly if a whole paragraph i just 'wrote' is just a bunch of quotation clumsily organised, if a chapter contains too many (or too few) citations.

that's the same logic for parentheses: _syntax highlights_ is supposed to make me see not only the _nature_ (or _role_) of the text components, but also to make me see the _structure_ of my code. and in texts in natural language (such as ones i wrote in markdown), parentheses play a role in this structure. therefore i want them to be highlights, to be visually isolated because they are semantic isolations.

comma comments

--------------

html comments are much too long, sometimes even longer than the comment itself:

```markdown

...as B. shows  in _Art worlds_...

```

that's why i added a shorter and easier-to-write syntax. i never use double commas in my text and commas are very accessible in many keyboards so it seems to be a good option. (i did not want to use `//` becaus i often use this in my notes.)

the bash script is meant to be used as a preprocessing tool. it remove comma comments and add newlines between files (just as Pandoc would do).

```bash

./uncomma *.md | pandoc -

```

if you use [Comment.nvim](https://github.com/numToStr/Comment.nvim) plugin, adding following code will say Comment.nvim to use `,,` syntax for (un)commenting:

```lua

local ft = require('Comment.ft')

ft.set('markdown', {',,%s'})

```

install

-------

just like any other vim plugin, using you plugin manager file to `syntax/markdown.vim`.

if you want to use the additional syntax, you need to set an option:

```vim

let g:markdown_polyphony=1

```

treesitter

----------

if you have treesitter installed, you have to ensure that "markdown" is disabled (or not installed).