From 516fbe94490dbe71355975c688c1b8d780082510 Mon Sep 17 00:00:00 2001 From: Wang Shidong Date: Sun, 28 Apr 2019 14:00:36 +0800 Subject: [PATCH] Add lang#ipynb layer (#2772) --- autoload/SpaceVim/layers/lang/ipynb.vim | 35 ++++++++++++ autoload/SpaceVim/layers/lang/markdown.vim | 2 +- docs/cn/layers.md | 44 ++++++++------- docs/cn/layers/lang/ipynb.md | 52 +++++++++++++++++ docs/layers.md | 66 +++++++++++----------- docs/layers/lang/ipynb.md | 51 +++++++++++++++++ 6 files changed, 196 insertions(+), 54 deletions(-) create mode 100644 autoload/SpaceVim/layers/lang/ipynb.vim create mode 100644 docs/cn/layers/lang/ipynb.md create mode 100644 docs/layers/lang/ipynb.md diff --git a/autoload/SpaceVim/layers/lang/ipynb.vim b/autoload/SpaceVim/layers/lang/ipynb.vim new file mode 100644 index 000000000..737d018c4 --- /dev/null +++ b/autoload/SpaceVim/layers/lang/ipynb.vim @@ -0,0 +1,35 @@ +"============================================================================= +" ipynb.vim --- lang#ipynb layer for SpaceVim +" Copyright (c) 2016-2017 Wang Shidong & Contributors +" Author: Wang Shidong < wsdjeg at 163.com > +" URL: https://spacevim.org +" License: GPLv3 +"============================================================================= + + +function! SpaceVim#layers#lang#ipynb#plugins() abort + let plugins = [] + " TODO: use remote plugin https://github.com/szymonmaszke/vimpyter + call add(plugins, ['wsdjeg/vimpyter', {'merged' : 0}]) + return plugins +endfunction + + +function! SpaceVim#layers#lang#ipynb#config() abort + call SpaceVim#mapping#space#regesit_lang_mappings('ipynb', function('s:language_specified_mappings')) +endfunction + +function! s:language_specified_mappings() abort + call SpaceVim#mapping#space#langSPC('nmap', ['l','p'], + \ 'VimpyterInsertPythonBlock', + \ 'insert python block', 1) + call SpaceVim#mapping#space#langSPC('nmap', ['l','u'], + \ 'VimpyterUpdate', + \ 'update note book', 1) + call SpaceVim#mapping#space#langSPC('nmap', ['l','j'], + \ 'VimpyterStartJupyter', + \ 'start jupyter', 1) + call SpaceVim#mapping#space#langSPC('nmap', ['l','n'], + \ 'VimpyterStartNteract', + \ 'start nteract', 1) +endfunction diff --git a/autoload/SpaceVim/layers/lang/markdown.vim b/autoload/SpaceVim/layers/lang/markdown.vim index 8ccb8c94d..03eda6dd6 100644 --- a/autoload/SpaceVim/layers/lang/markdown.vim +++ b/autoload/SpaceVim/layers/lang/markdown.vim @@ -39,7 +39,7 @@ function! SpaceVim#layers#lang#markdown#config() abort " the fenced languages based on loaded language layer let g:markdown_fenced_languages = [] let g:markdown_nested_languages = map(filter(SpaceVim#layers#get(), - \ 'v:val =~# "^lang#" && v:val !=# "lang#markdown" && v:val !=# "lang#vim"'), 'v:val[5:]') + \ 'v:val =~# "^lang#" && v:val !=# "lang#markdown" && v:val !=# "lang#ipynb" && v:val !=# "lang#vim"'), 'v:val[5:]') let g:vmt_list_item_char = s:md_listItemChar let g:markdown_minlines = 100 let g:markdown_syntax_conceal = 0 diff --git a/docs/cn/layers.md b/docs/cn/layers.md index 5ac51d29c..046e41458 100644 --- a/docs/cn/layers.md +++ b/docs/cn/layers.md @@ -64,9 +64,9 @@ Vim 插件以及相关配置。而 SpaceVim 是以模块的方式来组织和管 | [chat](chat/) | 这一模块为 SpaceVim 提供了一个聊天框架，目前支持微信聊天和 QQ 聊天，同时支持自定义聊天服务器。 | | [checkers](checkers/) | 这一模块为 SpaceVim 提供了代码语法检查的特性，同时提供代码实时检查，并列出语法错误的位置。 | | [chinese](chinese/) | 这一模块为 SpaceVim 的中文用户提供了中文的 Vim 帮助文档，同时提供部分插件的中文帮助文档。 | -| [colorscheme](colorscheme/) | 这一模块为 SpaceVim 提供了一系列的常用颜色主题，默认情况下使用深色 gruvbox 作为默认主题。该模块提供了快速切换主题、随机主题等特性。| +| [colorscheme](colorscheme/) | im colorscheme 模块 | | [core#banner](core/banner/) | 这一模块为 SpaceVim 提供了许多显示在启动界面的 Logo。 | -| [core#statusline](core/statusline/) | 这一模块为 SpaceVim 提供了默认的模式化的状态栏支持。 | +| [core#statusline](core/statusline/) | 这一模块为 SpaceVim 提供了一个高度定制的状态栏。 | | [core#tabline](core/tabline/) | 这一模块为 SpaceVim 提供了更好的标签栏。 | | [core](core/) | 这一模块为 SpaceVim 提供了启动及基本操作所必须的插件及配置。 | | [cscope](cscope/) | 这一模块为 SpaceVim 提供了一个智能的 cscope 和 pycscope 辅助工具，可以快速调用 cscope 常用命令。 | @@ -93,48 +93,50 @@ Vim 插件以及相关配置。而 SpaceVim 是以模块的方式来组织和管 | [lang#dockerfile](lang/dockerfile/) | 这一模块为 SpaceVim 提供了 Dockerfile 编辑的部分功能支持，包括语法高亮和自动补全。 | | [lang#elixir](lang/elixir/) | 这一模块为 SpaceVim 提供了 Elixir 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | | [lang#elm](lang/elm/) | 这一模块为 SpaceVim 提供了 Elm 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#erlang](lang/erlang/) | 这一模块为 erlang 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#erlang](lang/erlang/) | 这一模块为 Erlang 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | | [lang#extra](lang/extra/) | 这一模块为 SpaceVim 提供了一些不常见的语言添加语法支持，主要包括语法高亮、对齐等特性。 | | [lang#fsharp](lang/fsharp/) | 这一模块为 SpaceVim 提供了 FSharp 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | | [lang#go](lang/go/) | 这一模块为 SpaceVim 提供了 Go 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | | [lang#haskell](lang/haskell/) | 这一模块为 SpaceVim 提供了 Haskell 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | | [lang#html](lang/html/) | 这一模块为 SpaceVim 提供了 HTML 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#java](lang/java/) | 这一模块为 java 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#javascript](lang/javascript/) | 这一模块为 javascript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#julia](lang/julia/) | 这一模块为 julia 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#kotlin](lang/kotlin/) | 该模块为 SpaceVim 提供了 kotlin 语言开发支持，包括语法高亮、语言服务器支持。 | -| [lang#latex](lang/latex/) | 这一模块为 latex 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#lisp](lang/lisp/) | 这一模块为 lisp 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#lua](lang/lua/) | 这一模块为 lua 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#markdown](lang/markdown/) | 这一模块为 markdown 编辑提供支持，包括格式化、自动生成文章目录、代码块等特性。 | -| [lang#nim](lang/nim/) | 该模块为 SpaceVim 提供 nim 开发支持，包括语法高亮、代码补全、编译运行以及交互式编程等功能。 | -| [lang#ocaml](lang/ocaml/) | 这一模块为 ocaml 开发提供了支持，包括语法高亮、代码补全、以及定义处跳转等功能。 | -| [lang#perl](lang/perl/) | 这一模块为 perl 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#ipynb](lang/ipynb/) | 该模块为 SpaceVim 添加了 Jupyter Notebook 支持，包括语法高亮、代码折叠等特点。 | +| [lang#java](lang/java/) | 这一模块为 Java 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#javascript](lang/javascript/) | 这一模块为 JavaScript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#julia](lang/julia/) | 这一模块为 Julia 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#kotlin](lang/kotlin/) | 该模块为 SpaceVim 提供了 Kotlin 语言开发支持，包括语法高亮、语言服务器支持。 | +| [lang#latex](lang/latex/) | 这一模块为 LaTex 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#lisp](lang/lisp/) | 这一模块为 Lisp 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#lua](lang/lua/) | 这一模块为 Lua 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#markdown](lang/markdown/) | 这一模块为 Markdown 编辑提供支持，包括格式化、自动生成文章目录、代码块等特性。 | +| [lang#nim](lang/nim/) | 该模块为 SpaceVim 提供 Nim 开发支持，包括语法高亮、代码补全、编译运行以及交互式编程等功能。 | +| [lang#ocaml](lang/ocaml/) | 这一模块为 OCaml 开发提供了支持，包括语法高亮、代码补全、以及定义处跳转等功能。 | +| [lang#perl](lang/perl/) | 这一模块为 Perl 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | | [lang#php](lang/php/) | 这一模块为 SpaceVim 提供了 PHP 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | | [lang#plantuml](lang/plantuml/) | 这一模块为 SpaceVim 提供了 PlantUML 的开发支持，包括语法高亮、实时预览等特性。 | | [lang#puppet](lang/puppet/) | 这一模块为 SpaceVim 提供了 Puppet 的开发支持，包括语法高亮、语言服务器支持。 | | [lang#purescript](lang/purescript/) | 这一模块为 SpaceVim 提供了 PureScript 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#python](lang/python/) | 这一模块为 python 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#python](lang/python/) | 这一模块为 Python 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | | [lang#r](lang/r/) | 这一模块为 R 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#red](lang/red/) | 这一模块为 red 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#ruby](lang/ruby/) | 这一模块为 ruby 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#rust](lang/rust/) | 这一模块为 rust 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#scala](lang/scala/) | 这一模块为 scala 开发提供支持，包括语法高亮，函数列表等特性 | +| [lang#red](lang/red/) | 这一模块为 Red 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#ruby](lang/ruby/) | 这一模块为 Ruby 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#rust](lang/rust/) | 这一模块为 Rust 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#scala](lang/scala/) | 这一模块为 Scala 开发提供支持，包括语法高亮，函数列表等特性。 | | [lang#scheme](lang/scheme/) | 这一模块为 SpaceVim 提供了 Scheme 语言开发支持，包括语法高亮、语言服务器支持。 | | [lang#sh](lang/sh/) | 这一模块为 SpaceVim 提供了 Shell Script 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | | [lang#swift](lang/swift/) | 这一模块为 SpaceVim 提供了 Swift 的开发支持，包括语法高亮、语法检查等特性。 | -| [lang#typescript](lang/typescript/) | 这一模块为 SpaceVim 提供了 Typescript 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#typescript](lang/typescript/) | 这一模块为 SpaceVim 提供了 TypeScript 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | | [lang#vim](lang/vim/) | 这一模块为 SpaceVim 提供了 Vimscript 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | | [lang#vue](lang/vue/) | 这一模块为 SpaceVim 提供了 Vue 的的开发支持，包括代码补全、语法检查、代码格式化等特性。 | | [language-server-protocol](language-server-protocol/) | 这一模块为 SpaceVim 提供了 language server protocol 的支持，提供更多语言相关服务。 | | [leaderf](leaderf/) | 这一模块为 SpaceVim 提供了以 leaderf 为核心的异步模糊查找机制，支持模糊搜索文件、历史记录、函数列表等。 | | [shell](shell/) | 这一模块为 SpaceVim 提供了终端集成特性，优化内置终端的使用体验。 | | [sudo](sudo/) | 这一模块为 SpaceVim 提供了以管理员身份读写文件的功能。 | +| [test](test/) | 这一模块为 SpaceVim 提供了一个测试框架，支持快速运行多种语言的单元测试。 | | [tmux](tmux/) | 这一模块为 SpaceVim 提供了一些在 Vim 内操作 tmux 的功能，使得在 tmux 窗口之间跳转更加便捷。 | | [tools#dash](tools/dash/) | 这一模块为 SpaceVim 提供了 Dash 支持，可快速查找光标位置的单词。 | | [tools](tools/) | 这一模块为 SpaceVim 提供了多种常用工具，包括日历、计算器等多种工具类插件，并针对 Vim8 以及 Neovim 提供了更好的插件选择。 | | [ui](ui/) | 这一模块为 SpaceVim 提供了 IDE-like 的界面，包括状态栏、文件树、语法树等等特性。 | -| [unite](unite/) | 这一模块为 SpaceVim 提供以 unite 为核心的模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 | +| [unite](unite/) | 这一模块为 SpaceVim 提供以 Unite 为核心的模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 | diff --git a/docs/cn/layers/lang/ipynb.md b/docs/cn/layers/lang/ipynb.md new file mode 100644 index 000000000..62989780a --- /dev/null +++ b/docs/cn/layers/lang/ipynb.md @@ -0,0 +1,52 @@ +--- +title: "SpaceVim lang#ipynb 模块" +description: "该模块为SpaceVim添加了 Jupyter Notebook 支持，包括语法高亮、代码折叠等特点。" +--- + +# [可用模块](../../) >> lang#ipynb + + + +- [模块简介](#模块简介) +- [功能特性](#功能特性) +- [模块启用及依赖安装](#模块启用及依赖安装) +- [快捷键](#快捷键) + + + +## 模块简介 + +该模块为 SpaceVim 添加了 Jupyter Notebook 的支持，包括语法高亮，代码块折叠等特性。 + +## 功能特性 + +- 语法高亮 + +## 模块启用及依赖安装 + +这一模块包括了插件 vimpyter，这一插件需要安装一个 python 依赖包 notedown： + +```sh +pip install --user notedown +``` + +注意：如果在使用 windows 系统，可能在运行以上命令后，任然无法使用 notedown 命令， +需要手动将如下路径加入 PATH 环境变量： + +`%HOME%\AppData\Roaming\Python\Python37\Scripts` + +`lang#ipynb` 模块默认并未启用，如果需要启用该模块，需要在配置文件里面加入： + +```toml +[[layers]] + name = "lang#ipynb" +``` + +## 快捷键 + +| 快捷键 | 功能描述 | +| --------- | ------------------ | +| `SPC l p` | 插入 python 代码块 | +| `SPC l u` | 更新 note book | +| `SPC l j` | 启动 jupyter | +| `SPC l n` | 启动 nteract | diff --git a/docs/layers.md b/docs/layers.md index 16e79f1c2..8d80cc5cb 100644 --- a/docs/layers.md +++ b/docs/layers.md @@ -89,51 +89,53 @@ Some layers are enabled by default. The following example shows how to disable ` | [gtags](gtags/) | This layer provide gtags manager for project | | [japanese](japanese/) | Layer for japanese users, include japanese docs and runtime messages | | [lang#WebAssembly](lang/WebAssembly/) | This layer adds WebAssembly support to SpaceVim | -| [lang#agda](lang/agda/) | This layer adds agda language support to SpaceVim | -| [lang#asciidoc](lang/asciidoc/) | Edit asciidoc within vim, autopreview asciidoc in the default browser, with this layer you can also format asciidoc file. | -| [lang#autohotkey](lang/autohotkey/) | This layer adds autohotkey language support to SpaceVim | -| [lang#c](lang/c/) | c/c++/object-c language support for SpaceVim, include code completion, jump to definition, quick runner. | -| [lang#clojure](lang/clojure/) | This layer is for clojure development, provide autocompletion, syntax checking, code format for clojure file. | -| [lang#coffeescript](lang/coffeescript/) | This layer is for coffeescript development, provide autocompletion, syntax checking, code format for coffeescript file. | +| [lang#agda](lang/agda/) | This layer adds Agda language support to SpaceVim. | +| [lang#asciidoc](lang/asciidoc/) | Edit AsciiDoc within vim, autopreview AsciiDoc in the default browser, with this layer you can also format AsciiDoc file. | +| [lang#autohotkey](lang/autohotkey/) | This layer adds AutohotKey language support to SpaceVim. | +| [lang#c](lang/c/) | C/C++/Object-C language support for SpaceVim, include code completion, jump to definition, quick runner. | +| [lang#clojure](lang/clojure/) | This layer is for Clojure development, provide autocompletion, syntax checking, code format for Clojure file. | +| [lang#coffeescript](lang/coffeescript/) | This layer is for CoffeeScript development, provide autocompletion, syntax checking, code format for CoffeeScript file. | | [lang#csharp](lang/csharp/) | This layer is for csharp development | -| [lang#dart](lang/dart/) | This layer is for dart development, provide autocompletion, syntax checking, code format for dart file. | +| [lang#dart](lang/dart/) | This layer is for Dart development, provide autocompletion, syntax checking, code format for Dart file. | | [lang#dockerfile](lang/dockerfile/) | This layer adds DockerFile to SpaceVim | -| [lang#elixir](lang/elixir/) | This layer is for elixir development, provide autocompletion, syntax checking, code format for elixir file. | -| [lang#elm](lang/elm/) | This layer is for elm development, provide autocompletion, syntax checking, code format for elm file. | -| [lang#erlang](lang/erlang/) | This layer is for erlang development, provide autocompletion, syntax checking, code format for erlang file. | +| [lang#elixir](lang/elixir/) | This layer is for Elixir development, provide autocompletion, syntax checking, code format for Elixir file. | +| [lang#elm](lang/elm/) | This layer is for Elm development, provide autocompletion, syntax checking, code format for Elm file. | +| [lang#erlang](lang/erlang/) | This layer is for Erlang development, provide autocompletion, syntax checking, code format for Erlang file. | | [lang#extra](lang/extra/) | This layer adds extra language support to SpaceVim | -| [lang#fsharp](lang/fsharp/) | This layer adds fsharp language support to SpaceVim | +| [lang#fsharp](lang/fsharp/) | This layer adds FSharp language support to SpaceVim | | [lang#go](lang/go/) | This layer is for golang development. It also provides additional language-specific key mappings. | -| [lang#graphql](lang/graphql/) | This layer adds graphql file support to SpaceVim | -| [lang#haskell](lang/haskell/) | haskell language support for SpaceVim, includes code completion, syntax checking, jumping to definition, also provides language server protocol support for haskell | +| [lang#graphql](lang/graphql/) | This layer adds GraphQL file support to SpaceVim | +| [lang#haskell](lang/haskell/) | Haskell language support for SpaceVim, includes code completion, syntax checking, jumping to definition, also provides language server protocol support for Haskell | | [lang#html](lang/html/) | Edit html in SpaceVim, with this layer, this layer provides code completion, syntax checking and code formatting for html. | +| [lang#ipynb](lang/ipynb/) | This layer adds Jupyter Notebook support to SpaceVim | | [lang#java](lang/java/) | This layer is for Java development. All the features such as code completion, formatting, syntax checking, REPL and debug have be done in this layer. | | [lang#javascript](lang/javascript/) | This layer is for JaveScript development | -| [lang#julia](lang/julia/) | This layer is for julia development, provide autocompletion, syntax checking and code formatting | -| [lang#kotlin](lang/kotlin/) | This layer adds kotlin language support to SpaceVim | +| [lang#julia](lang/julia/) | This layer is for Julia development, provide autocompletion, syntax checking and code formatting | +| [lang#kotlin](lang/kotlin/) | This layer adds Kotlin language support to SpaceVim, including syntax highlighting, code runner and REPL support. | | [lang#latex](lang/latex/) | This layer provides support for writing LaTeX documents, including syntax highlighting, code completion, formatting etc. | -| [lang#lisp](lang/lisp/) | This layer is for lisp development, provide autocompletion, syntax checking, code format for lisp file. | -| [lang#lua](lang/lua/) | This layer is for lua development, provide autocompletion, syntax checking, code format for lua file. | +| [lang#lisp](lang/lisp/) | This layer is for Lisp development, provide autocompletion, syntax checking, code format for Lisp file. | +| [lang#lua](lang/lua/) | This layer is for Lua development, provide autocompletion, syntax checking, code format for Lua file. | | [lang#markdown](lang/markdown/) | Edit markdown within vim, autopreview markdown in the default browser, with this layer you can also format markdown file. | -| [lang#nim](lang/nim/) | This layer adds nim language support to SpaceVim | -| [lang#ocaml](lang/ocaml/) | This layer is for ocaml development, provide autocompletion, syntax checking, code format for ocaml file. | -| [lang#perl](lang/perl/) | This layer is for perl development, provide autocompletion, syntax checking, code format for perl file. | +| [lang#nim](lang/nim/) | This layer adds Nim language support to SpaceVim | +| [lang#ocaml](lang/ocaml/) | This layer is for OCaml development, provide autocompletion, syntax checking, code format for OCaml file. | +| [lang#perl](lang/perl/) | This layer is for Perl development, provide autocompletion, syntax checking, code format for Perl file. | | [lang#php](lang/php/) | This layer adds PHP language support to SpaceVim | -| [lang#plantuml](lang/plantuml/) | This layer is for plantuml development, syntax highlighting for plantuml file. | -| [lang#puppet](lang/puppet/) | This layer adds puppet language support to SpaceVim | -| [lang#purescript](lang/purescript/) | This layer is for purescript development, provide autocompletion, syntax checking, code format for purescript file. | -| [lang#python](lang/python/) | This layer is for Python development, provide autocompletion, syntax checking, code format for python file. | +| [lang#plantuml](lang/plantuml/) | This layer is for PlantUML development, syntax highlighting for PlantUML file. | +| [lang#processing](lang/processing/) | This layer is for working on Processing sketches. It provides sytnax checking and an app runner | +| [lang#puppet](lang/puppet/) | This layer adds Puppet language support to SpaceVim | +| [lang#purescript](lang/purescript/) | This layer is for PureScript development, provide autocompletion, syntax checking, code format for PureScript file. | +| [lang#python](lang/python/) | This layer is for Python development, provide autocompletion, syntax checking, code format for Python file. | | [lang#r](lang/r/) | This layer is for R development, provide autocompletion, syntax checking and code format. | -| [lang#red](lang/red/) | This layer is for red development, provide autocompletion, syntax checking and code format. | -| [lang#ruby](lang/ruby/) | This layer is for ruby development, provide autocompletion, syntax checking, code format for ruby file. | -| [lang#rust](lang/rust/) | This layer is for rust development, provide autocompletion, syntax checking, code format for rust file. | -| [lang#scala](lang/scala/) | This layer adds scala language support to SpaceVim | -| [lang#scheme](lang/scheme/) | This layer adds scheme language support to SpaceVim | +| [lang#red](lang/red/) | This layer is for Red development, provide autocompletion, syntax checking and code format. | +| [lang#ruby](lang/ruby/) | This layer is for Ruby development, provide autocompletion, syntax checking, code format for Ruby file. | +| [lang#rust](lang/rust/) | This layer is for Rust development, provide autocompletion, syntax checking, code format for Rust file. | +| [lang#scala](lang/scala/) | This layer adds Scala language support to SpaceVim | +| [lang#scheme](lang/scheme/) | This layer adds Scheme language support to SpaceVim | | [lang#sh](lang/sh/) | Shell script development layer, provides autocompletion, syntax checking, code format for bash and zsh script. | | [lang#swift](lang/swift/) | swift language support for SpaceVim, includes code completion, syntax highlighting | -| [lang#typescript](lang/typescript/) | This layer is for TypeScript development | -| [lang#vim](lang/vim/) | This layer is for writting vim script, including code completion, syntax checking and buffer formatting | -| [lang#vue](lang/vue/) | This layer adds vue language support to SpaceVim | +| [lang#typescript](lang/typescript/) | This layer is for TypeScript development, includding code completion, Syntax lint, and doc generation. | +| [lang#vim](lang/vim/) | This layer is for writting Vimscript, including code completion, syntax checking and buffer formatting | +| [lang#vue](lang/vue/) | This layer adds Vue language support to SpaceVim | | [language-server-protocol](language-server-protocol/) | This layers provides language server protocol for vim and neovim | | [leaderf](leaderf/) | This layers provide a heavily customized LeaderF centric work-flow | | [shell](shell/) | This layer provide shell support in SpaceVim | diff --git a/docs/layers/lang/ipynb.md b/docs/layers/lang/ipynb.md new file mode 100644 index 000000000..e9bf5174a --- /dev/null +++ b/docs/layers/lang/ipynb.md @@ -0,0 +1,51 @@ +--- +title: "SpaceVim lang#ipynb layer" +description: "This layer adds Jupyter Notebook support to SpaceVim" +--- + +# [Available Layers](../../) >> lang#ipynb + + + +- [Description](#description) +- [Features](#features) +- [Install](#install) +- [Key bindings](#key-bindings) + + + +## Description + +This layer adds Jupyter Notebook support to SpaceVim. + +## Features + +- syntax highlighting + +## Install + +this layer includes vimpyter, to use this plugin, you may need to install notedown. + +```sh +pip install --user notedown +``` + +NOTE: if you are using windows, you need to add this dir to your \$PATH. + +`%HOME%\AppData\Roaming\Python\Python37\Scripts` + +To use this configuration layer, update custom configuration file with: + +```toml +[[layers]] + name = "lang#ipynb" +``` + +## Key bindings + +| Key bindings | Description | +| ------------ | ------------------- | +| `SPC l p` | insert python block | +| `SPC l u` | update note book | +| `SPC l j` | start jupyter | +| `SPC l n` | start nteract |