Vim wiki editable by git

classic Classic list List threaded Threaded
13 messages Options
Reply | Threaded
Open this post in threaded view
|

Vim wiki editable by git

MarcWeber
As you all know I wrote VAM to solve a problem: Vim plugins
distribution.

The Vim community suffers from a second problem:
There are many plugins - some are outdated - and its sometimes hard to
find the "jewels" - because they may be hosted on github only.
There is a wiki, but its not integrated in the main site - neither is it
easy for external people to hack on it just using what they know best:
"Vim" (right?)

For this reason I'd like to start a wiki like text file based git
repository which summarizes the most useful tools (and maybe
alternatives) so that people who want to find answers about:
"How to I most efficiently code xy" or do "z".

Of course vim help files come to mind, they already support links and
code blocks - and there are existing tools to turn them into HTML
(so that the contents can be pushed to www.vim.org one day) - still
markup is little bit limited.

Are there alternatives you'd choose for such an effort which can be
translated to HTML easily and which can be edited and read by Vim, too?

Also would you be interested in joining and helping maintain such a
git based wiki?

Its not about writing comprehensive documentation, rather about creating
an index about which tools are known to solve a problem. This can be
completion, configuration, running a compiler and more.

Feedback about this idea and ideas are welcome.
Marc Weber

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

ping song
On 2/24/2013 6:34 PM, Marc Weber wrote:

> As you all know I wrote VAM to solve a problem: Vim plugins
> distribution.
>
> The Vim community suffers from a second problem:
> There are many plugins - some are outdated - and its sometimes hard to
> find the "jewels" - because they may be hosted on github only.
> There is a wiki, but its not integrated in the main site - neither is it
> easy for external people to hack on it just using what they know best:
> "Vim" (right?)
>
> For this reason I'd like to start a wiki like text file based git
> repository which summarizes the most useful tools (and maybe
> alternatives) so that people who want to find answers about:
> "How to I most efficiently code xy" or do "z".
>
> Of course vim help files come to mind, they already support links and
> code blocks - and there are existing tools to turn them into HTML
> (so that the contents can be pushed to www.vim.org one day) - still
> markup is little bit limited.
>
> Are there alternatives you'd choose for such an effort which can be
> translated to HTML easily and which can be edited and read by Vim, too?
>
> Also would you be interested in joining and helping maintain such a
> git based wiki?
>
> Its not about writing comprehensive documentation, rather about creating
> an index about which tools are known to solve a problem. This can be
> completion, configuration, running a compiler and more.
>
> Feedback about this idea and ideas are welcome.
> Marc Weber
>
I think this is a great idea!!
can save people's a lot time when seeking for the "best plugins" to do a
certain kind of work.
I think we can call it a "vim best practice" project :)

regards
ping

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

Benjamin Fritz
In reply to this post by MarcWeber
On Sunday, February 24, 2013 5:34:48 PM UTC-6, MarcWeber wrote:

> As you all know I wrote VAM to solve a problem: Vim plugins
>
> distribution.
>
>
>
> The Vim community suffers from a second problem:
>
> There are many plugins - some are outdated - and its sometimes hard to
>
> find the "jewels" - because they may be hosted on github only.
>
> There is a wiki, but its not integrated in the main site - neither is it
>
> easy for external people to hack on it just using what they know best:
>
> "Vim" (right?)
>
>
>
> For this reason I'd like to start a wiki like text file based git
>
> repository which summarizes the most useful tools (and maybe
>
> alternatives) so that people who want to find answers about:
>
> "How to I most efficiently code xy" or do "z".
>
>
>
> Of course vim help files come to mind, they already support links and
>
> code blocks - and there are existing tools to turn them into HTML
>
> (so that the contents can be pushed to www.vim.org one day) - still
>
> markup is little bit limited.
>
>
>
> Are there alternatives you'd choose for such an effort which can be
>
> translated to HTML easily and which can be edited and read by Vim, too?
>
>
>
> Also would you be interested in joining and helping maintain such a
>
> git based wiki?
>
>
>
> Its not about writing comprehensive documentation, rather about creating
>
> an index about which tools are known to solve a problem. This can be
>
> completion, configuration, running a compiler and more.
>
>
>
> Feedback about this idea and ideas are welcome.
>
> Marc Weber

I'd never use such a document, unless I stumbled across it in a web search.

I will probably continue to get plugins (when I need them) from searching the web, seeing recommendations on this list, and seeing mentions on #vim on Freenode.

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

Jeroen Budts
In reply to this post by MarcWeber
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 02/25/2013 12:34 AM, Marc Weber wrote:

> As you all know I wrote VAM to solve a problem: Vim plugins
> distribution.
>
> The Vim community suffers from a second problem: There are many
> plugins - some are outdated - and its sometimes hard to find the
> "jewels" - because they may be hosted on github only. There is a
> wiki, but its not integrated in the main site - neither is it easy
> for external people to hack on it just using what they know best:
> "Vim" (right?)
>
> For this reason I'd like to start a wiki like text file based git
> repository which summarizes the most useful tools (and maybe
> alternatives) so that people who want to find answers about: "How
> to I most efficiently code xy" or do "z".
>
> Of course vim help files come to mind, they already support links
> and code blocks - and there are existing tools to turn them into
> HTML (so that the contents can be pushed to www.vim.org one day) -
> still markup is little bit limited.
>
> Are there alternatives you'd choose for such an effort which can
> be translated to HTML easily and which can be edited and read by
> Vim, too?
>
> Also would you be interested in joining and helping maintain such
> a git based wiki?
>
> Its not about writing comprehensive documentation, rather about
> creating an index about which tools are known to solve a problem.
> This can be completion, configuration, running a compiler and
> more.
>
> Feedback about this idea and ideas are welcome. Marc Weber
>
Vimwiki immediately comes to my mind. It has nice syntax highlighting in
Vim; supports most common markup such as bold, italic, 6 (?) levels of
headers, quotes, lists, code blocks etc; It also supports linking to
other pages, to external pages, to pages in other wiki's, to files etc.
Vimwiki supports multiple syntaxes (default, markup, wikipedia). When
using the default syntax you can easily export the entire wiki to HTML.
It also let's you use your custom html template for that.
I have been using vimwiki for a few years now to take notes and I really
like how easy it is. Although I don't export to HTML, since I always
read it in Vim.

http://www.vim.org/scripts/script.php?script_id=2226

Jeroen


- --
website: http://budts.be/ - twitter: @teranex
___________________________________
Registered Linux User #482240 - GetFirefox.com - ubuntu.com



-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.17 (GNU/Linux)

iQIcBAEBCAAGBQJRKx4LAAoJEBrqc/v4ufiMNPUQAKN3ZaLa5QY8BwNLKtPekxLu
Y8pH7faPAo+CHMN0XZgau1ZtE4a0EZqsXrNKn3IaO2K8dGIAYRNoMEGkzNU3F/7r
XqOOLdlzulb5n/JZNuXN9MBPWWZIxMy4StVpPzUAAUp/YSdVwop41yjwPiMVTFQ3
A/BcQTrjcOK83ox6QXJxLJgZizfk8bKJK9k9U0eivwRFmBUHtchuccvkxwhpJEso
M9VmkkIruJ7KCqYo5sAHKnvNZNuv8ereN4luNOAxP5icOnues4giVGnxNAsqqREi
5U+b2uII4qctKTbC3R5Kz5w40MbaRGzR5nx6TCRVvG42flghQ83BFdUH5SfvNzbN
RSD2qhMuCO1lf+VN3ej1QzCydlHnHNB53gVA96vQMtLvj2yMgi4kpXaR8ghU1NU+
gM8k5SpDi7RzOtBf3no4TCrzhmeAWVjlOE2i7BklsWNAlpSdkSCamCaaq/TpeY99
pa8MmYsphUjosUMkcRP0vvcowCuMFxovlxz66rUxalaEGKtR/qIMBqkTeHE5aVXj
ukEdWwOuHWOFacmzIHe8kS0F5pdVqJ2fhQS+p47f0ZQEoUIynmh01APLzboehV9m
vLUyaUu6aMI4FHgpzDuCNCWbd90+ldVSQs6z6EkJ4E4OBUjFIkCTEg2V62RFeTGf
DQVEi8E9u2yKusJi6aw1
=Jk4p
-----END PGP SIGNATURE-----

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

Eric Weir

On Feb 25, 2013, at 3:17 AM, Jeroen Budts wrote:

> I have been using vimwiki for a few years now to take notes and I really
> like how easy it is. Although I don't export to HTML, since I always
> read it in Vim.
>
> http://www.vim.org/scripts/script.php?script_id=2226

When I am in vim I am mostly in vimwiki.

One revelation of working with it has been that, at least in it, I can get along with just one folder. The key to that is the hypertext linking it provides. Previously I had relied on an elaborate file system evolved practically from my beginning to work with computers.

That, of course, is with my own writing, and only with exploratory or unformatted part of it. With other people's documents ort my own finished work I still rely on the file system.

Regards,
------------------------------------------------------------------------------------------
Eric Weir
[hidden email]

β€œOn the basis of evidence we may be sure that we are wrong
but we can never be sure that we are right.” - Richard Feynman

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

MarcWeber
In reply to this post by MarcWeber
I've just started the effort:
  https://github.com/MarcWeber/vim-git-wiki

Join, contribute and provide feedback. If everybody only adds
information about what he/she knows best we'll have the greatest
resource very fast. Then its time to put it online at www.vim.org if
Bram agrees (I guess he will).

Marc Weber

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

Eric Weir
On Feb 25, 2013, at 9:35 AM, Marc Weber <[hidden email]> wrote:

> If everybody only adds
> information about what he/she knows best we'll have the greatest
> resource very fast.

Should work. But how will you insure that it doesn't become just another complete, unselective collection, i.e., that only the best,plugins are included?
 
--------------------------------------------------------------------------------
Eric Weir
Decatur, GA. USA

"The invincible shield of caring
is a weapon from the sky
against being dead."

– Tao Te Ching, 67

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

glts
In reply to this post by MarcWeber
Hi Marc

I made my own list of popular plugins recently. My approach was less
wiki, more "wikimatrix.org". Maybe you can find some useful ideas in
there:

http://glts.github.com/VimPluginMatrix/

Cheers, glts

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

MarcWeber
> http://glts.github.com/VimPluginMatrix/
You're welcome to join and contribute. In which way does your list
differ from what www.vim.org provides?

Example: does it tell me why you starred pathogen and not Vundle or VAM
(using plugin management filter?)

You have both in the list: YouCompleteMe and neocomplcache - which one
do you use for what reason?

I think this is the information users are looking for.

I don't understand what PnP means. Probably you mean viml only - no need
to compile vim with python or external tools?

Marc Weber

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

glts
Oh, it's just a personal list, something I could point a newcomer to. If
you take a look at "wikimatrix.org": I think that's an excellent format,
lots of tabular data points that you can compare directly with one
another.

I just tried to emulate that format in a primitive way. The date should
give some indication whether development is active, the "plug-and-play"
tick should tell you if you can just unzip/git clone and don't need
external dependencies/config, etc.

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

MarcWeber
Excerpts from glts's message of Tue Feb 26 22:15:55 +0100 2013:
> Oh, it's just a personal list, something I could point a newcomer to. If
> you take a look at "wikimatrix.org": I think that's an excellent format,
> lots of tabular data points that you can compare directly with one
> another.
Which says nothing. Again - why do you prefer pathogen over the others?
Why is it starred? That's why your list is useless.

My goal is a guide like this:

A lot of people prefer X for this reason, others prefer Y for that
reason. Then people know which solution to choose and why without trying
everything and the kitchen sink.

Marc Weber

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

Antony Scriven-3
In reply to this post by MarcWeber
On 24 February 2013 23:34, Marc Weber wrote:

 > As you all know I wrote VAM to solve a problem: Vim plugins
 > distribution.
 >
 > The Vim community suffers from a second problem: There
 > are many plugins - some are outdated - and its sometimes
 > hard to find the "jewels" - because they may be hosted on
 > github only. There is a wiki, but its not integrated in
 > the main site - neither is it easy for external people to
 > hack on it just using what they know best: "Vim" (right?)
 >
 > For this reason I'd like to start a wiki like text file
 > based git repository which summarizes the most useful
 > tools (and maybe alternatives) so that people who want to
 > find answers about: "How to I most efficiently code xy"
 > or do "z".
 >
 > [...]

I agree there's a problem. I think vim.org could do with
some modernising.

 > Also would you be interested in joining and helping
 > maintain such a git based wiki?

A wiki is a great idea. And they maintain themselves,
courtesy of those who give a shit. I think it should be on
vim.org though (I realise this is your ultimate intent too).

 > Its not about writing comprehensive documentation, rather
 > about creating an index about which tools are known to
 > solve a problem. This can be completion, configuration,
 > running a compiler and more.

Agreed. These questions come up *a lot*, and finding the
answers with Google is surprisingly difficult. What you get
are blog posts saying 'you can hack foo integration into Vim
with these custom mappings which happen to rely on custom
program x which is in my environment but you'll have to
compile it from source ...,' etc.

This isn't a criticism: because Vim is so customisable,
people can easily whip up their own systems which solve the
problem at hand but aren't always helpful for the beginner
(or seasoned professional!) trying to learn Python, for
example.

The current state of affairs is quite fragmented.
There's vim.org, the mailing list, the Vim tips wiki,
scripts on vim.org, other scripts on Github, discussion on
#vim, many questions on Stack Overflow .... Where to look?

Certainly I think the scripts section on vim.org needs
a thorough revamp.

 > Feedback about this idea and ideas are welcome.

Well, I also think that vim.org would benefit from
a chatroom, Stack Overflow style. I've no doubt it
would be popular among new users of Vim. #vim has
loads of new users asking questions, and who uses IRC
these days? :-)

I think, given the enduring popularity of Vim, it needs
a centralised resource.

--Antony

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.


Reply | Threaded
Open this post in threaded view
|

Re: Vim wiki editable by git

MarcWeber
> with these custom mappings which happen to rely on custom
> program x which is in my environment but you'll have to
> compile it from source ...,' etc.
But that's not solved by a wiki - compiling from source is always work.
Its only solved by source friendly distributions like gentoo or
nixos.

> Well, I also think that vim.org would benefit from
> a chatroom, Stack Overflow style.
Stack Overflow is already being used.
http://webchat.freenode.net/
Information about how to use that

> loads of new users asking questions, and who uses IRC
> these days? :-)
Many people, join and see yourself.

> I think, given the enduring popularity of Vim, it needs
> a centralised resource.
Rewriting Vim is out of my scope - I've had plans to do so for months.
So I try to apply 20/80 rule again.

Thanks for joining and contributing ideas. A short irc howto is already
there now.

Marc Weber

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/groups/opt_out.