You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20Lines changed: 20 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -232,6 +232,14 @@ If for any reason you want to recreate the list of tags you can execute the `:In
232
232
233
233
This command converts the current note to HTML. It works by first converting the current note to [Markdown][markdown] and then using the `markdown` program to convert that to HTML. It requires an external program to convert Markdown to HTML. By default the program `markdown` is used, but you can change the name of the program using the `g:notes_markdown_program` option.
234
234
235
+
To convert your note to html and open it in a browser, you can run:
236
+
237
+
:NoteToHtml
238
+
239
+
Alternatively, to convert your note to html and display it in a new split in vim, you can run:
240
+
241
+
:NoteToHtml split
242
+
235
243
Note that this command can be a bit slow, because the parser for the note taking syntax is written in Vim script (for portability) and has not been optimized for speed (yet).
236
244
237
245
### The `:NoteToMarkdown` command
@@ -246,6 +254,16 @@ Convert the current note to a [Markdown document] [markdown]. The vim-notes synt
246
254
247
255
Note that this command can be a bit slow, because the parser for the note taking syntax is written in Vim script (for portability) and has not been optimized for speed (yet).
248
256
257
+
### The `:NoteToMediawiki` command
258
+
259
+
Convert the current note to a [Mediawiki document][mediawiki]. This is similar to the `:NoteToMarkdown` command, but it produces wiki text that can be displayed on a Mediawiki site. That being said, the subset of wiki markup that vim-notes actually produces will probably work on other wiki sites. These are the notable transforations:
260
+
261
+
* The first line of the note is a title, but it isn't used in the Mediawiki syntax. It could have been put into a `= Title =` tag, but it doesn't really make sense in the context of a wiki. It would make the table of contents nest under the title for every document you create.
262
+
263
+
* Preformatted blocks are output into `<syntaxhighlight lang="..">` tags. This functionality is enabled on Mediawiki through the [SyntaxHighlight GeSHi extention][geshi]. It is also supported on Wikipedia.
264
+
265
+
* Currently, the `***` divider isn't translated into anything.
266
+
249
267
## Mappings
250
268
251
269
The following key mappings are defined inside notes.
@@ -360,6 +378,8 @@ This software is licensed under the [MIT license] [mit].
0 commit comments