Git Product home page Git Product logo

vim-tiddlywiki's Introduction

This is a fork of http://www.vim.org/scripts/script.php?script_id=2705

For people who like the TiddlyWiki formatting syntax.

http://tiddlywiki.org/wiki/TiddlyWiki_Markup

It has since been highly customized and updated.

This plugin provides syntax highlighting for tiddlywiki files (*.tid) as well as some helpers for editing TiddlyWiki files. It is probably best used in conjunction with TiddlyWiki Bob, since it is designed to smoothly handle tiddlers being changed both via TiddlyWiki as well as directly on the file system.

Usage

Provided Commands

  • TiddlyWikiUpdateMetadata : Update the 'modifier' and 'modified' fields in the current tiddler's metadata.
  • TiddlyWikiInitializeTemplate : Insert tiddler metadata (timestamps, creator / modifier / title) at the top of the file
  • TiddlyWikiEditTiddler <name> : Open the tiddler with that name (without '.tid' extension) or create it if it doesn't exist

The TiddlyWikiEditTiddler command looks for tiddlers in the following locations (in that order):

  • If g:tiddlywiki_dir is set:
    • g:tiddlywiki_dir/
    • g:tiddlywiki_dir/tiddlers/
  • Otherwise:
    • ./
    • ./tiddlers/
    • ~/wiki/
    • ~/wiki/tiddlers/

Default Mappings

nmap <Leader>tm :TiddlyWikiUpdateMetadata<Cr>
nmap <Leader>tt :TiddlyWikiInitializeTemplate<Cr>
nmap <Leader>te :TiddlyWikiEditTiddler<Space>
nmap <Leader>tE :vsplit<cr>:TiddlyWikiEditTiddler<Space>

Configuration

" Explicitly set the username of the tiddler 'creator' and 'modifier'
" If not set, this defaults to `$USER` or `$LOGNAME` (in that order)
let g:tiddlywiki_author = 'thisisme'

" Specify the location of your tiddlers. The subdir "tiddlers" is appended automatically if required.
let g:tiddlywiki_dir = '~/docs/notes/wiki'

" Disable the default mappings
let g:tiddlywiki_no_mappings=1

" Automatically update tiddler metadata ('modified' timestamp, 'modifier' 
" username) on write
let g:tiddlywiki_autoupdate=1

vim-tiddlywiki's People

Contributors

sukima avatar creinig avatar jceb avatar swaroopch avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.