Giter VIP home page Giter VIP logo

wikilink's Introduction

"WikiLink" is a Vim plugin which eases the navigation between files 
 in a personnal wiki
 Links syntax currently supported follows Github's Gollum (https://github.com/gollum/gollum)
  [[My displayed link|My link]]

 This plugin also detects footerbar and sidebar files and splits the window accordingly (again, see Gollum for syntax)

 Installation
 ------------
 Copy the wikilink.vim file into the $HOME/.vim/plugin/ directory

 Configuration
 -------------
 Window split on footer and sidebar detection can be disabled by writing this
 line on your .vimrc file :
 let wikilinkAutosplit="off"

 Usage
 -----
 Hit the ENTER key when the cursor is on a wiki link
 The corresponding file is loaded in the current buffer

 Hit Shift + ENTER to go back

wikilink's People

Contributors

mmai avatar benjaminoakes avatar cnodell avatar krisoijn avatar lightxue avatar

Stargazers

 avatar Morgan Aldridge avatar manunam avatar Anton Vykhovanets avatar  avatar Matt Petty avatar Mark Tozzi avatar Martijn Hemeryck avatar Ernst Widerberg avatar Mark Bainter avatar Elliot Penson avatar Edward Vielmetti avatar  avatar Yuya Saito avatar Mayeu avatar Sean Chen avatar  avatar  avatar

Watchers

Edward Vielmetti avatar  avatar James Cloos avatar  avatar  avatar

wikilink's Issues

PAGE LINKS

According to gollum

[[Frodo|Frodo Baggins]]
The above tag will link to Frodo-Baggins.ext using "Frodo" as the link text.

However, this is not the case for wikilink. much thanks!

License please?

Hello,

I'm interested in using and possibly contributing to this plugin, but currently there's no posted license which could make doing so technically illegal for me, even though the code is posted publicly. Could you add a license file please?

Many vim plugins simply say they are licensed under the same terms as vim itself (Vim's license is found here: http://vimdoc.sourceforge.net/htmldoc/uganda.html#license). You can find more choices here: https://opensource.org/licenses/alphabetical. Vim's license is considered GPL compatible, so GPL is also an option if you prefer. I would encourage you not to chose what the Apache org calls a "nonsensical" license, which has clauses that have no clear legal definition, such as "don't be a dick". You can read more at https://www.apache.org/legal/resolved.html#what-can-we-not-include-in-an-asf-project-category-x

Thanks in advance. I know this is a pretty boring ask, but unfortunately the current state of software copyrights requires us to attend to these things for everyone's protection.

Footer/Sidebar opening should be optional

Nice idea, thanks for this plugin!

I think the footer/sidebar detection and opening should be optional though, I really don't want my split windows being rearranged unexpectedly -- at least and especially, don't do the exec "winc o" in the WikiLinkShowStructure function if there is no footer or sidebar found. Right now if I'm editing a few wiki pages in split windows, every time I follow a link in one of them all my other windows get closed, and that's simply maddening.

It will probably also conflict with Vimwiki which uses a .wiki file extension, and also provides handy support for opening web links in addition to wiki links with the Enter key, convenient mappings for opening in splits with Shift/Ctrl-Enter, etc. (I use Vimwiki for a personal knowledge base, and Gollum for project-specific wikis when the source is hosted on GitHub). Any ideas on how conflicts could be worked around?

I'll see if I can whip up a pull request or two when I have some time to play with it!

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.