diff --git a/docs/about.md b/docs/about.md index 7875f7db6..c95ed312b 100644 --- a/docs/about.md +++ b/docs/about.md @@ -1,28 +1,38 @@ --- -title: "About" +title: "About" description: "The goals, credits and contact information about SpaceVim." --- -# [Home](../) >> About +# About -[SpaceVim](https://github.com/SpaceVim/SpaceVim) is a community-driven Vim distribution with a [layers](../layers/) feature. -SpaceVim manages collections of plugins in layers. Layers make it easy for you, the user, to enable a new -language or feature by grouping all the related plugins together. It got inspired by spacemacs. + -## Contact us +- [History](#history) +- [Goals](#goals) +- [Contact](#contact) +- [Credits & Thanks](#credits--thanks) -You can get in touch with us using the support email. -Your message will be sent to our teams, who will get back to you as soon as they can. -Please be advised that weekends and public holidays might delay response time. + -Email: [support@spacevim.org](mailto:support@spacevim.org) +## History + +SpaceVim started in December 2016 as a spin-off from @wsdjeg's [DotFiles repository](https://github.com/wsdjeg/DotFiles). +An early idea for modular configuration came from the Vim configuration by airline's author. +The earliest version was further influenced by spacemacs' layer concept. ## Goals - Mnemonic key bindings navigation -- More IDE-like features in Vim and Neovim -- Better language support by default -- Cross platform experience +- More IDE-like features in both Vim and Neovim +- Better programming language support +- Cross-platform consistency +- Fast start up and efficient operation + +## Contact + +You can get in touch with the maintainer by send email to [support@spacevim.org](mailto:support@spacevim.org). +Your message will be sent to our teams, who will get back to you as soon as they can. +Please be advised that weekends and public holidays might delay response time. ## Credits & Thanks @@ -30,7 +40,9 @@ This project exists thanks to all the people who have contributed: -- [@Gabirel](https://github.com/Gabirel) and his [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim) -- [@everettjf](https://github.com/everettjf) and his [SpaceVimTutorial](https://everettjf.gitbooks.io/spacevimtutorial/content/) +- [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim) by [@Gabirel](https://github.com/Gabirel) +- [SpaceVimTutorial](https://everettjf.gitbooks.io/spacevimtutorial/content/) by [@everettjf](https://github.com/everettjf) +- [10-minutes-to-SpaceVim](https://github.com/Jackiexiao/10-minutes-to-SpaceVim) by [@Jackiexiao](https://github.com/Jackiexiao) +- [A First Look At SpaceVim](https://www.youtube.com/watch?v=iXPS_NHLj9k) by [@DistroTube](https://www.youtube.com/channel/UCVls1GmFKf6WlTraIb_IaJg) - [vimdoc](https://github.com/google/vimdoc) generate doc file for SpaceVim - Authors of all the plugins used in SpaceVim. diff --git a/docs/cn/about.md b/docs/cn/about.md index efaa2d8ca..e70463466 100644 --- a/docs/cn/about.md +++ b/docs/cn/about.md @@ -4,21 +4,40 @@ description: "创建SpaceVim这一项目的目的在于提供一个开箱即用 lang: zh --- -# [主页](../) >> 关于我们 +# 关于我们 -[SpaceVim](https://github.com/SpaceVim/SpaceVim) 是一个社区驱动的模块化 Vim/Neovim 配置集合,以模块的方式组织管理插件以 -及相关配置,为不同的语言开发量身定制了相关的开发模块,该模块提供代码自动补全, -语法检查、格式化、调试、REPL 等特性。用户仅需载入相关语言的模块即可得到一个开箱 -即用的 Vim-IDE。这一项目的灵感来自于 spacemacs。 + -### 目标 +- [起源](#起源) +- [目标](#目标) +- [联系方式](#联系方式) +- [特别鸣谢](#特别鸣谢) -- 提供可跨平台的优雅的用户体验。 -- 让搭建不同语言开发环境变得更便捷。 + -### 鸣谢 +## 起源 -感谢所有曾经向 SpaceVim 贡献过代码的用户: +SpaceVim 这一项目起源于 2016 年 12 月份,是由 @wsdjeg 的 [DotFiles](https://github.com/wsdjeg/DotFiles) 仓库分离衍生出来的。 +早起的模块化配置理念来源于 airline 作者的 Vim 配置。 +进一步受到 spacemacs 的 layers 这一概念的影响,最终形成了最早期的版本。 + +## 目标 + +- 智能快捷键导航 +- 实现更多的 IDE 功能,支持 Vim 和 Neovim +- 更好的编程语言支持 +- 跨平台的一致性 +- 快速启动、高效运行 + +## 联系方式 + +你可以通过发送邮件至 [support@spacevim.org](mailto:support@spacevim.org) 与维护者取得联系。 +你的信息会被发送给我们的团队,我们会尽快回复你。 +请注意,周末和节假日可能会延迟响应时间。 + +## 特别鸣谢 + +感谢所有参与 SpaceVim 开发的用户: diff --git a/docs/cn/community.md b/docs/cn/community.md index 61ac2ab2d..61a3f0bde 100644 --- a/docs/cn/community.md +++ b/docs/cn/community.md @@ -4,7 +4,7 @@ description: "SpaceVim 中文社区,包括中文技术问答、资讯订阅、 lang: zh --- -# [主页](../) >> 中文社区 +# 中文社区 为了方便 SpaceVim 用户使用中文交流,提供以下中文频道,请根据实际需求选择合适的频道寻求帮助或参与讨论。 @@ -12,56 +12,27 @@ lang: zh - [资讯订阅](#资讯订阅) - [问题反馈](#问题反馈) -- [经验分享](#经验分享) -- [邮件列表](#邮件列表) - [即时聊天](#即时聊天) +- [邮件列表](#邮件列表) -### 资讯订阅 +## 资讯订阅 -最新的版本发布、新功能增加会通过 twitter 或者 Facebook 进行推送,欢迎订阅: +最新的版本发布、新功能增加会通过微博、Twitter 或者 Facebook 进行推送,欢迎订阅: +- [新浪微博](https://weibo.com/u/7317706188) - [twitter](https://twitter.com/SpaceVim) - [Facebook](https://www.facebook.com/SpaceVim) -### 问题反馈 +## 问题反馈 在正常使用 SpaceVim 时,如果遇到 Bug 或者有新的特性需求可以通过 Github 或者码云的问题列表来提交。 - [码云](https://gitee.com/spacevim/SpaceVim/issues) -(中文) - [GitHub](https://github.com/SpaceVim/SpaceVim) -(英文) -### 经验分享 - -如果你有想分享的东西,或者有想深入讨论的问题,请使用以下论坛: - -- [知乎](https://www.zhihu.com/topic/20168681/newest) -- [思否](https://segmentfault.com/t/spacevim) -- [黑客派](https://hacpai.com/tag/spacevim) -- [贴吧](https://tieba.baidu.com/spacevim) - -### 邮件列表 - -习惯使用邮件的用户,也可以通过[中文邮件组](https://groups.google.com/forum/#!forum/spacevim-cn)进行交流,可以发送邮件至邮件列表参与讨论: - -``` -spacevim-cn@googlegroups.com -``` - -在使用该邮件列表发帖之前,需要加入邮件组,可以通过发送一条空的邮件至: - -``` -spacevim-cn+subscribe@googlegroups.com -``` - -如果需要取消订阅该邮件列表,则可以发送一条空邮件至: - -``` -spacevim-cn+unsubscribe@googlegroups.com -``` - -### 即时聊天 +## 即时聊天 以下几个频道作为 SpaceVim 中文用户交流平台,之间消息实现了互通,请选择任意合适的频道参与交流。 也可以在网页右下角点击加入聊天,进群后,请不要发布无意义的内容,在你提问前, @@ -75,3 +46,13 @@ spacevim-cn+unsubscribe@googlegroups.com - [`#spacevim` discord 聊天室](https://discord.gg/g3MGdNB) 以上为同步聊天群,同时SpaceVim有对应的QQ群:[970953433](https://jq.qq.com/?_wv=1027&k=XYqDdQTM) + +## 邮件列表 + +习惯使用邮件的用户,也可以通过[中文邮件组](https://groups.google.com/forum/#!forum/spacevim-cn)进行交流, +可以发送邮件至邮件列表参与讨论: + +``` +spacevim-cn@googlegroups.com +``` + diff --git a/docs/cn/development.md b/docs/cn/development.md index d723cbb24..b42ae20c3 100644 --- a/docs/cn/development.md +++ b/docs/cn/development.md @@ -4,7 +4,7 @@ description: "本文档是 SpaceVim 开发者文档,描述了:1. 如何提 lang: zh --- -# [主页](../) >> 开发者文档 +# 开发者文档 diff --git a/docs/cn/documentation.md b/docs/cn/documentation.md index bde9b4efa..c846bf84c 100644 --- a/docs/cn/documentation.md +++ b/docs/cn/documentation.md @@ -5,7 +5,7 @@ redirect_from: "/README_zh_cn/" lang: zh --- -# [主页](../) >> 使用文档 +# 使用文档 diff --git a/docs/cn/quick-start-guide.md b/docs/cn/quick-start-guide.md index 01ab8d156..f710ced65 100644 --- a/docs/cn/quick-start-guide.md +++ b/docs/cn/quick-start-guide.md @@ -5,7 +5,7 @@ lang: zh --- -# [主页](../) >> 入门指南 +# 入门指南 如果你从未使用过 SpaceVim,建议先阅读这篇简短的教程。这篇教程主要讲述: 如何安装 SpaceVim,SpaceVim 的入门配置以及 SpaceVim 常用学习资源。 diff --git a/docs/cn/sponsors.md b/docs/cn/sponsors.md index 148d09632..20941246b 100644 --- a/docs/cn/sponsors.md +++ b/docs/cn/sponsors.md @@ -4,7 +4,7 @@ description: "SpaceVim 赞助方式,以及历史赞助,如果你想赞助 Sp lang: zh --- -# [主页](../) >> 赞助 +# 赞助 如果你想赞助 SpaceVim,或者希望 SpaceVim 开发得更快一点,可以选择以下某种方式进行赞助: diff --git a/docs/community.md b/docs/community.md index 78591a084..4dbc3b1a6 100644 --- a/docs/community.md +++ b/docs/community.md @@ -3,60 +3,34 @@ title: "Community" description: "A list of SpaceVim's public channels, All messages are bridged between IRC, gitter, telegram, matrix and slack" --- -# [Home](../) >> Community +# Community - [News](#news) - [Feedback](#feedback) -- [Mailing list](#mailing-list) - [Chat](#chat) - [Forum](#forum) +- [Mailing list](#mailing-list) - [Others](#others) -### News +## News The news about spacevim will be post on twitter or facebook, feel free to follow them: - [Twitter](https://twitter.com/SpaceVim) - [Facebook](https://www.facebook.com/SpaceVim) -### Feedback +## Feedback If you run into a bug or want a new feature. Please use the [issue tracker](https://github.com/SpaceVim/SpaceVim/issues) to report any bugs or file feature requests. -### Mailing list - -Users who are accustomed to using email can also communicate with each other through the mailing list. -They can send email to the mailing list to participate in the discussion. - -``` -spacevim@googlegroups.com -``` - -Please note that to post on these lists, you must be a member, -To join this group send an empty message to: - -``` -spacevim+subscribe@googlegroups.com -``` - -To unsubscribe, send an empty message to: - -``` -spacevim+unsubscribe@googlegroups.com -``` - -You can also view all the mail list history via google forum: - -- [google groups](https://groups.google.com/forum/#!forum/spacevim) - -### Chat +## Chat All messages in these channels are bridged together. Messages from `SpaceVimBot` are sent by a remote user. @@ -69,15 +43,23 @@ Join on one of them to chat with us: - [`#spacevim` on slack](https://spacevim.slack.com/messages/C88CTJ62J) - [`#spacevim` on discord](https://discord.gg/xcRQnF8) -### Forum +## Forum If you have something you'd like to share, or a question you'd like to discuss in depth, use the following forums: - [Reddit channel](https://reddit.com/r/spacevim) - [Facebook group](https://www.facebook.com/groups/spacevim) +## Mailing list -### Others +Users who are accustomed to using email can also communicate with each other through the [google mailing list](https://groups.google.com/forum/#!forum/spacevim). +They can send email to the mailing list to participate in the discussion. + +``` +spacevim@googlegroups.com +``` + +## Others - [GitHub](https://github.com/SpaceVim/SpaceVim) - [YouTube](https://www.youtube.com/channel/UC-3q4dVFS7gBpxhrON1WxIA) diff --git a/docs/development.md b/docs/development.md index afb971bc7..94417addd 100644 --- a/docs/development.md +++ b/docs/development.md @@ -3,7 +3,7 @@ title: "Development" description: "General contributing guidelines and changelog of SpaceVim, including development information about SpaceVim" --- -# [Home](../) >> Development +# Development diff --git a/docs/documentation.md b/docs/documentation.md index 8fe7f88a9..fd38462b9 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -3,7 +3,7 @@ title: "Documentation" description: "General documentation about how to use SpaceVim, including the quick start guide and FAQs." --- -# [Home](../) >> Documentation +# Documentation diff --git a/docs/quick-start-guide.md b/docs/quick-start-guide.md index 3b91eeb02..356cd9370 100644 --- a/docs/quick-start-guide.md +++ b/docs/quick-start-guide.md @@ -3,7 +3,7 @@ title: "Quick start guide" description: "A quick start guide which will tell you how to install and configure SpaceVim, also provides a list of resources for learning SpaceVim." --- -# [Home](../) >> Quick start guide +# Quick start guide @@ -12,7 +12,7 @@ description: "A quick start guide which will tell you how to install and configu - [Windows](#windows) - [Run in docker](#run-in-docker) - [Configuration](#configuration) -- [Online tutor](#online-tutor) +- [Online tutorials](#online-tutorials) - [Learning SpaceVim](#learning-spacevim) diff --git a/docs/sponsors.md b/docs/sponsors.md index a609d1d77..2404b91fe 100644 --- a/docs/sponsors.md +++ b/docs/sponsors.md @@ -3,7 +3,7 @@ title: "Sponsors" description: "The companies or individuals contributing a monthly amount to help sustain SpaceVim's development." --- -# [Home](../) >> Sponsors +# Sponsors