-
Notifications
You must be signed in to change notification settings - Fork 1
[ADD] Adding blog post of publishing goyo.vim documentation #7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| layout: post | ||
| title: "Vim helpfile for plugin goyo.vim" | ||
| date: "2017-03-30 12:02:58 +0530" | ||
| tags: vim helpfile documentation | ||
| --- | ||
|
|
||
|  | ||
|
|
||
| ## Goyo Plugin | ||
|
|
||
| [goyo.vim][goyo] is a popular plugin for [vim][vim] editor. This plugin helps | ||
| the writers to concentrate on their writing while they are writing. Recently I | ||
| was playing with [goyo.vim][goyo] plugin and found the [vim][vim] helpfile is | ||
| missing. The author did a good job of describing API of the plugin at | ||
| **README.MD** file, but it is more helpful if the documentation is provided as a | ||
| [vim][vim] specific **helpfile**. I have prepared initial [vim][vim] helpfile | ||
| for this plugin. I hope it will help the users of this plugins. Below are the | ||
| steps for adding helpfile for your goyo.vim plugin. | ||
|
|
||
|
|
||
| ### Steps for adding goyo.vim helpfile | ||
|
|
||
| Find the location of your `.vim` directory. In | ||
| [GNU/Linux](https://en.wikipedia.org/wiki/Linux) workstation it is located under | ||
| your **home** directory. Create documentation directory under your vim | ||
| directory. Below command creates document directory and change your current | ||
| directory to `.vim/doc` directory. | ||
|
|
||
| {% highlight shell %} | ||
| mkdir -p ~/.vim/doc && cd ~/.vim/doc | ||
| {% endhighlight %} | ||
|
|
||
| Download the goyo.vim helpfile | ||
|
|
||
| {% highlight shell %} | ||
| wget https://git.io/vSGAK -O goyo_help.txt | ||
| {% endhighlight %} | ||
|
|
||
| For generating the tag file, Open the [vim][vim] editor and write below command. | ||
|
|
||
| {% highlight vim %} | ||
| :helptags ~/.vim/doc | ||
| {% endhighlight %} | ||
|
|
||
| Done! You will be able to get help from your [vim][vim] editor by typing below command. | ||
|
|
||
| {% highlight vim %} | ||
| :help goyo_text.txt | ||
| {% endhighlight %} | ||
|
|
||
| ### Found improvements? | ||
|
|
||
| I am volunteering the task of maintaining helpfile for goyo.vim plugin until it | ||
| is provided natively. If you find any improvements, errors I request to drop me | ||
| a mail at [jaysinhp@gmail.com](mailto:jaysinhp@gmail.com). I am open for | ||
| suggestions. This helpfile is maintained | ||
| [here](https://gist.github.com/ultimatecoder/491e6da43f2f796446068d427f6668bc) | ||
| as a Github gist. | ||
|
|
||
| [goyo]: https://github.com/junegunn/goyo.vim | ||
| [vim]: http://www.vim.org | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shortened url?