jyapayne/nvim-nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added base of doc

Browse source
This commit is contained in:
baabelfish 2016-01-30 15:51:52 +02:00
commit 5eaddba1dd
2 changed files with 88 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -1,4 +1,4 @@
# nvim-structure
# nvim-nim
Attempt at writing an async outline/structure listing/navigator for files/modules.
# TODO

87
doc/nim.txt Normal file
View file

@ -0,0 +1,87 @@
*nim.txt* All you need working with Nim in Vim
==============================================================================
CONTENTS *nim-contents*
1.Intro.................................................|NimIntro|
2.Features..............................................|NimFeatures|
2.1.Syntax highlighting.............................|NimSyntaxHL|
2.2.Nimsuggest interaction..........................|NimSuggest|
2.1.Get symbol information......................|NimSInfo|
2.2.Goto symbol.................................|NimSGoto|
2.3.Find usages.................................|NimSUsages|
2.4.Refactoring.................................|NimSRefactoring|
2.5.Outline (symbols in a module)...............|NimSOutline|
3.Options...............................................|NimOptions|
3.1.Option summary..................................|NimOptionSummary|
3.2.Option details..................................|NimOptionDetails|
4.Nim Keymappings.......................................|NimKeymappings|
5.About.................................................|NimAbout|
6.License...............................................|NimLicense|
==============================================================================
1.Intro *NimIntro*
==============================================================================
2.Features *NimFeatures*
------------------------------------------------------------------------------
2.1.Syntax highlighting *NimSyntaxHL*
------------------------------------------------------------------------------
2.2.Nimsuggest interaction *NimSuggest*
------------------------------------------------------------------------------
2.1.Get symbol information *NimSInfo*
------------------------------------------------------------------------------
2.2.Goto symbol *NimSGoto*
------------------------------------------------------------------------------
2.3.Find usages *NimSUsages*
------------------------------------------------------------------------------
2.4.Refactoring *NimSRefactoring*
------------------------------------------------------------------------------
2.5.Outline (symbols in a module) *NimSOutline*
==============================================================================
3.Options *NimOptions*
------------------------------------------------------------------------------
3.1.Option summary *NimOptionSummary*
------------------------------------------------------------------------------
3.2.Option details *NimOptionDetails*
==============================================================================
4.Nim Keymappings *NimKeymappings*
==============================================================================
5.About *NimAbout*
==============================================================================
6.License *NimLicense*
The MIT License (MIT)
Copyright (c) 2016 Niko Junkala
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.