Permalink
Browse files

Markdown sucks

  • Loading branch information...
1 parent 51691c1 commit e706a98a599a745f67acbb74f501532fab619357 @xolox committed Nov 26, 2011
Showing with 54 additions and 25 deletions.
  1. +17 −6 README.md
  2. +37 −19 doc/notes.txt
View
@@ -237,13 +237,24 @@ See the documentation of the [:highlight] [highlight] command for more informati
## Other plug-ins that work well with the notes plug-in
- * The [utl.vim] [utl] universal text linking plug-in enables links between your notes, other local files and remote resources like web pages.
- * My [shell.vim] [shell] plug-in also enables easy navigation between your notes and environment like local files and directories, web pages and e-mail addresses by providing key mappings and commands to e.g. open the file/URL under the text cursor. This plug-in can also change Vim to full screen which can be really nice for large notes.
- * The [VOoM] [voom] outlining plug-in should work well for notes if you use the Markdown style headers starting with `#`, however it has been reported that this combination may not always work so well in practice (sometimes losing notes!)
- * If the text formatting supported by the notes plug-in is not enough for you, consider trying the [Txtfmt] [txtfmt] (The Vim Highlighter) plug-in. To use the two plug-ins together, create the file `after/ftplugin/notes.vim` inside your Vim profile with the following contents:
+### utl.vim
- " Integration between notes.vim and txtfmt.vim.
- :setlocal filetype=notes.txtfmt
+The [utl.vim] [utl] universal text linking plug-in enables links between your notes, other local files and remote resources like web pages.
+
+### shell.vim
+
+My [shell.vim] [shell] plug-in also enables easy navigation between your notes and environment like local files and directories, web pages and e-mail addresses by providing key mappings and commands to e.g. open the file/URL under the text cursor. This plug-in can also change Vim to full screen which can be really nice for large notes.
+
+### VOoM
+
+The [VOoM] [voom] outlining plug-in should work well for notes if you use the Markdown style headers starting with `#`, however it has been reported that this combination may not always work so well in practice (sometimes losing notes!)
+
+### Txtfmt
+
+If the text formatting supported by the notes plug-in is not enough for you, consider trying the [Txtfmt] [txtfmt] (The Vim Highlighter) plug-in. To use the two plug-ins together, create the file `after/ftplugin/notes.vim` inside your Vim profile with the following contents:
+
+ " Enable Txtfmt formatting inside notes.
+ setlocal filetype=notes.txtfmt
## Contact
View
@@ -458,25 +458,43 @@ are the names of the syntax items defined by the notes syntax mode:
===============================================================================
Other plug-ins that work well with the notes plug-in ~
- - The utl.vim [6] universal text linking plug-in enables links between your
- notes, other local files and remote resources like web pages.
-
- - My shell.vim [7] plug-in also enables easy navigation between your notes and
- environment like local files and directories, web pages and e-mail
- addresses by providing key mappings and commands to e.g. open the file/URL
- under the text cursor. This plug-in can also change Vim to full screen
- which can be really nice for large notes.
-
- - The VOoM [8] outlining plug-in should work well for notes if you use the
- Markdown style headers starting with '#', however it has been reported that
- this combination may not always work so well in practice (sometimes losing
- notes!)
-
- - If the text formatting supported by the notes plug-in is not enough for you,
- consider trying the Txtfmt [9] (The Vim Highlighter) plug-in. To use the
- two plug-ins together, create the file 'after/ftplugin/notes.vim' inside
- your Vim profile with the following contents: " Integration between
- notes.vim and txtfmt.vim. :setlocal filetype=notes.txtfmt
+-------------------------------------------------------------------------------
+ *notes-utl.vim*
+utl.vim ~
+
+The utl.vim [6] universal text linking plug-in enables links between your
+notes, other local files and remote resources like web pages.
+
+-------------------------------------------------------------------------------
+ *notes-shell.vim*
+shell.vim ~
+
+My shell.vim [7] plug-in also enables easy navigation between your notes and
+environment like local files and directories, web pages and e-mail addresses
+by providing key mappings and commands to e.g. open the file/URL under the
+text cursor. This plug-in can also change Vim to full screen which can be
+really nice for large notes.
+
+-------------------------------------------------------------------------------
+ *notes-voom*
+VOoM ~
+
+The VOoM [8] outlining plug-in should work well for notes if you use the
+Markdown style headers starting with '#', however it has been reported that
+this combination may not always work so well in practice (sometimes losing
+notes!)
+
+-------------------------------------------------------------------------------
+ *notes-txtfmt*
+Txtfmt ~
+
+If the text formatting supported by the notes plug-in is not enough for you,
+consider trying the Txtfmt [9] (The Vim Highlighter) plug-in. To use the two
+plug-ins together, create the file 'after/ftplugin/notes.vim' inside your Vim
+profile with the following contents:
+>
+ " Enable Txtfmt formatting inside notes.
+ setlocal filetype=notes.txtfmt
===============================================================================
*notes-contact*

3 comments on commit e706a98

Sometimes yes :), but mainly no.

Owner

xolox replied Nov 27, 2011

Of course you're right, I love Markdown (most of the time). That's why I use it in my GitHub readmes, on my own website, etc. I even wrote a converter from Markdown to Vim help file format. However every once in a while one of the more complicated corner cases of Markdown syntax bites me in the ass, and of course I don't notice until I've already published the new version and my GitHub project page and homepage are broken. Then I go to vent my frustration on GitHub... Probably not the best venue for my frustration, but hey, these are open source projects so the world gets to see it all, the good and the ugly :-).

In this particular case, I guess the separate headings are an improvement because now I can link to individual items on my homepage (the backend automatically creates anchors for all headings).

I understand you, I'm using the hammer-plugin - just press :Hammer and
it will open a nice preview of the markdown files in your browsers - this will prevent you from
useless "Just-README-changes-commits".

Hope to help you.

Please sign in to comment.