Skip to content

Commit 7d9eb3d

Browse files
[ADD] Blog post for publishing goyo-doc vim plugin (#8)
* [ADD] Adding blog post publishing vim specific helpfile for goyo.vim plugin written as new plugin goyo-doc. Proofreaded by Farhaan Bukhsh * [ADD] Adding proofreader as Farhaan
1 parent 06fdb1d commit 7d9eb3d

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: post
3+
title: "goyo-doc: Vim helpfile for goyo.vim plugin"
4+
date: "2017-04-10 17:51:48 +0530"
5+
---
6+
7+
![goyo_doc_plugin]({{site.url}}/assets/images/goyo_doc_plugin.png)
8+
9+
10+
### What is Goyo?
11+
12+
[Goyo][goyo] is the vim plugin which allows writers to focus on their writing
13+
while they are writing. The plugin deactivates not required fancy windows which
14+
are not useful at the time of using vim for writing. It provides certain
15+
customizations too.
16+
17+
18+
### What is missing in Goyo?
19+
20+
The main problem with [Goyo][goyo] plugin is that it carries very weak vim
21+
specific helpfile. A vimmer is habituated to find help at vim specific helpfile
22+
first. After few attempts, I have decided to write a good helpfile for the
23+
[Goyo][goyo] plugin. I am happy to maintain the documentation I have started
24+
with the ongoing development of the plugin until the author of [Goyo][goyo] is
25+
providing any concise helpfile for it. The [goyo-doc][goyo-doc] is not carrying
26+
any source of [Goyo][goyo] plugin, but only contains documentation for the
27+
plugin. I am inviting you to propose improvements if you find any.
28+
29+
30+
### Why I decided to write a separate plugin for documentation?
31+
32+
> "Documentation is essential. There needs to be something for people to read,
33+
> even if it's rudimentary and incomplete."
34+
>
35+
> -- <cite>K.Fogel, Producing Open source software</cite>
36+
37+
I believe the documentation is the most important part of any software. While I
38+
was using [Goyo][goyo] plugin, I found it is missing the vim specific helpfile.
39+
I discussed this issue with the author and offered the help for improving on
40+
this. You can read further about early discussions
41+
[here](https://github.com/junegunn/goyo.vim/issues/144). I didn't get any
42+
positive response from the author so I decided to write and launch vim specific
43+
helpfile for this plugin. With this plugin, I am expecting to provide the
44+
solution to those users who are more familiar with vim specific helpfile than a
45+
Github wiki or README file of any project. Below are the links for downloading
46+
and using the plugin.
47+
48+
49+
### Download links
50+
51+
* [Vimscript](http://www.vim.org/scripts/script.php?script_id=5546)
52+
53+
* [Github][goyo-doc]
54+
55+
56+
###### Proofreader: [Farhaan Bukhsh](https://farhaanbukhsh.wordpress.com/)
57+
58+
[goyo]: https://github.com/junegunn/goyo.vim
59+
[goyo-doc]: https://github.com/ultimatecoder/goyo-doc

assets/images/goyo_doc_plugin.png

78.5 KB
Loading

0 commit comments

Comments
 (0)