Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions _posts/2017-04-10-goyo-doc-vim-helpfile-for-goyo-plugin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
layout: post
title: "goyo-doc: Vim helpfile for goyo.vim plugin"
date: "2017-04-10 17:51:48 +0530"
---

![goyo_doc_plugin]({{site.url}}/assets/images/goyo_doc_plugin.png)


### What is Goyo?

[Goyo][goyo] is the vim plugin which allows writers to focus on their writing
while they are writing. The plugin deactivates not required fancy windows which
are not useful at the time of using vim for writing. It provides certain
customizations too.


### What is missing in Goyo?

The main problem with [Goyo][goyo] plugin is that it carries very weak vim
specific helpfile. A vimmer is habituated to find help at vim specific helpfile
first. After few attempts, I have decided to write a good helpfile for the
[Goyo][goyo] plugin. I am happy to maintain the documentation I have started
with the ongoing development of the plugin until the author of [Goyo][goyo] is
providing any concise helpfile for it. The [goyo-doc][goyo-doc] is not carrying
any source of [Goyo][goyo] plugin, but only contains documentation for the
plugin. I am inviting you to propose improvements if you find any.


### Why I decided to write a separate plugin for documentation?

> "Documentation is essential. There needs to be something for people to read,
> even if it's rudimentary and incomplete."
>
> -- <cite>K.Fogel, Producing Open source software</cite>

I believe the documentation is the most important part of any software. While I
was using [Goyo][goyo] plugin, I found it is missing the vim specific helpfile.
I discussed this issue with the author and offered the help for improving on
this. You can read further about early discussions
[here](https://github.com/junegunn/goyo.vim/issues/144). I didn't get any
positive response from the author so I decided to write and launch vim specific
helpfile for this plugin. With this plugin, I am expecting to provide the
solution to those users who are more familiar with vim specific helpfile than a
Github wiki or README file of any project. Below are the links for downloading
and using the plugin.


### Download links

* [Vimscript](http://www.vim.org/scripts/script.php?script_id=5546)

* [Github][goyo-doc]


###### Proofreader: [Farhaan Bukhsh](https://farhaanbukhsh.wordpress.com/)

[goyo]: https://github.com/junegunn/goyo.vim
[goyo-doc]: https://github.com/ultimatecoder/goyo-doc
Binary file added assets/images/goyo_doc_plugin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.