Code Monkey home page Code Monkey logo

neovim.github.io's Introduction

neovim.io website

This repository contains the source for the neovim.io website. The Neovim core project is: https://github.com/neovim/neovim Note that www.neovim.io/doc is served by https://github.com/neovim/doc (which previously crawled neovim.io/doc2 generated from this repository).

Contributing

Just fork this repository and send us a pull request! :-)

Setup

This assumes that you already have a recent Ruby with RubyGems.

Installing Ruby gems

Install Bundler, either systemwide:

sudo gem install bundler

or for the current user:

export PATH="$(ruby -e 'print Gem.user_dir')/bin:$PATH"
gem install --user-install bundler

In the latter case, you might want to add the PATH update to .bashrc or your shell's equivalent.

To install the dependencies for this project only:

bundle config set --local path .bundle
# To _update_ deps, remove the lockfile.
# rm Gemfile.lock
bundle install

Serving locally

Execute the following command:

bundle exec jekyll serve --watch --livereload

Open http://localhost:4000 to view the website.

Maintenance

License

© 2014 Cameron Eagans and Josh Branchaud

Licensed under the MIT License. See LICENSE for details.

neovim.github.io's People

Contributors

arhell avatar bfredl avatar bronzehedwick avatar brycefisher avatar clason avatar cweagans avatar dependabot[bot] avatar fmoralesc avatar fwalch avatar gpanders avatar jamessan avatar jbranchaud avatar jdavis avatar justinmk avatar killthemule avatar madis avatar meribold avatar mhinz avatar mjlbach avatar olical avatar rockerboo avatar saitheninja avatar shawndumas avatar shortcuts avatar tarruda avatar teto avatar timeyyy avatar unclechu avatar whereswaldon avatar zyx-i avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

neovim.github.io's Issues

unexpected shell behaviour

When executing a shell command like !rspec that has something that pauses the process, like https://github.com/pry/pry. nvim is not stopping and completing the entire process. In vim the process would pause allowing you to type in the shell prompt.

Font Awesome Src

Running jekyll serve

Configuration file: /home/crackerz/Development/code/neovimWebsite/_config.yml
            Source: /home/crackerz/Development/code/neovimWebsite
       Destination: /home/crackerz/Development/code/neovimWebsite/_site
      Generating...   Liquid Exception: Included file '/home/crackerz/Development/code/neovimWebsite/_includes/tests/stacked.html' not found in bower_components/font-awesome/src/test-2.3.2.html
error: Included file '/home/crackerz/Development/code/neovimWebsite/_includes/tests/stacked.html' not found. Use --trace to view backtrace

Temporary fix:
rm -rf bower_components/font-awesome/src
This could also be a permanent fix as I don't believe src isn't need for font-awesome to function. That being said, I feel like bower install && jekyll serve is all a user should have to do to get the site running.

License?

Thoughts on what license we should use for the website? I am partial to MIT.

Also, who should the license be under?

RSS feed not working over HTTP

It seems that the RSS feed at https://neovim.io/news.xml does not work over plain HTTP (i.e. curl http://neovim.io/news.xml returns an empty response).

While this should't be a problem by itself, there seems that the server has a very limited set of cipher suites. For example, while I can run curl https://neovim.io/news.xml from my mac, it fails from my CentOS 6 machine. It seems to also fail from https://validator.w3.org/feed/check.cgi?url=https://neovim.io/news.xml.

P.S.: I know this issue is not related to the code on this repo, but I'm not completely sure where this issue belong.

Error running bundle install

Trying to run bundle install but it can't find blankslate

macarthy at emilie in ~/projects/neovim.github.io on master
± bundle install
Fetching gem metadata from https://rubygems.org/.......
Fetching gem metadata from https://rubygems.org/..
Could not find blankslate-2.1.3 in any of the sources

gem install blankslate works fine , installing version 3.1.3 of blankslate

Not sure if this is an issue upstream, I'll have a look.

Temporary link to fundraiser in new site

There are 4 days remaining in the fundraiser for the Neovim project. Do we want to add a link to the fundraiser to the top of the site for the next 4 days (and remove it after that)? I don't think we want to miss out on any last minute pledges that could be the result of traffic from the site.

Replace Issue with Newsletter

For the next newsletter, use "Newsletter 5" instead of "Issue 5" as to not overload the term too much throughout the newsletter.

Web site unreachable with DNSSEC

Is it possible that neovim.io has DNSSEC validation broken? I get a SERVFAIL error whenever I try to access the site using my own DNS server (which uses dnscrypt-proxy). The site is available through my ISP's DNS service.

I haven't experimented much, but that's the only site I have found in more than one year with DNSSEC, which behaves the same as http://www.dnssec-failed.org.

Font size in vim help pages is tiny

I realize these things are subjective, but the 0.9rem sizing seems tiny in the vim help docs:

current sizing from main.css:

screen shot 2015-10-30 at 7 42 30 pm

Sizing removed via inspector:

screen shot 2015-10-30 at 7 42 27 pm

The only other place the main site seems to use pre is in the sponsors sidebar, which does look better at the smaller size, IMO.

neovim.org deeplinks broken

How is the redirection to the new .io domain set up? Is it possible to support deeplinks? Currently, e.g. neovim.org/doc redirects to the front page.

News for people sponsoring via bountysource

Hi

I like to ask you to write something about what is done using the money we sponsor. The last official news was in December 2015. It doesn't have to be too often, every 4 month would be sufficient. I know there is some news about the project in general on twitter, but we sponsor the work of @tarruda, so I am curious what is going on there.

Best,
Jean-Louis

News

treesitter:

tree-sitter is a parser framework. Best way to explain how cool it is, is to look at a test suite for one of its parsers. Here's the test suite for its C parser: https://github.com/tree-sitter/tree-sitter-cpp/tree/master/corpus
Each test is sample code following by an s-expression.
tree-sitter emits and consumes s-expressions to define an AST!
the grammars are defined in JS: https://github.com/tree-sitter/tree-sitter-cpp/blob/master/grammar.js . That compiles to C. And the C lib is what Nvim uses. And Nvim wraps the treesitter API, so you can augment parsers dynamically.
And the API is queryable, so the AST can be searched, and this can be used to define mappings, motions, etc.

2020

  • vim.regex() returns a Vim regex object

style guide: Require trailing comma

Current style guide does not talk about trailing commas in array and struct braced initializer list format. The example shows that it should be omitted in struct initialization, but I think this is bad idea in struct initializers (except for one-line ones) and it is especially bad idea in array initializers. Reasoning is simple and known: should you append element to the list without the trailing comma you are forced make not only one addition (+n lines line after last array element), but also a change to the last line of the last array element.

Thus I would suggest the following addition to the style guide: require trailing comma always when closing brace is placed on the separate line and require absense of trailing comma when closing brace is placed on the same line as the last element in the initializer list. This change does not even go against the example in http://neovim.io/develop/style-guide.xml?showone=Braced_Initializer_Lists#Braced_Initializer_Lists.

Create Wiki Page

We need a wiki page for the suggested content that is making its way into our issues. It will help us organize.

Landing page content?

Opening this so we can come up with an outline of what will go on the landing page.

@cweagans already mentioned that we definitely want a link to the bountysource funding page.

Backers/Sponsors page

The Bountysource fundraiser offers backers at the $500 and $1000 levels placement of their name and logo on the website. This is something we need to keep in mind.

Does this need to go on the front page or can we link from the front page to a sponsors page with all of this? The latter seems appropriate to me, but I have never had sponsors before, so what do I know.

Website logo?

We need to come up with a logo, there is currently an issue open for this over at the main neovim repo.

merge dev wiki to neovim.org

I don't see any reason to separate the dev wiki.

Suggestions:

  • the name "development wiki" should be discarded (it's not a wiki)
  • "GitHub" link should be renamed "Development" (?)
  • "polls" should become a call-to-action or at maybe a navigation link on the main page
  • the bitcoin section should become a minor section somewhere below the fold of the main page
  • the style guide should be a minor section under the "Logos" section. Or maybe we should only link to it from the source README.md.

After these changes the only subpage will be the "Polls" page. Currently we don't have enough content to justify a "Development" subpage.

Align the right column of 'Supporting the project' on homepage

The Bitcon header and nearby content should line up with the "Logos" above it. Currently the "Supporting the project" container is broken in half into two columns, whereas the rest of the homepage is split roughly into a larger 2/3 left column and a narrower 1/3 right column.

neovim wallpapers

I want to use neovim wallpapers like Vim wallpapers.
Can you create them?

change tagline

We need a new tagline to replace "rebirth for the 21st century", which was just a placeholder.

...Also because the current tagline is nearly identical the XEmacs tagline (go to http://www.xemacs.org/ and look at your browser window title). Yep.

I like the tagline

vim out of the box

because it conveys several important themes of Neovim:

  • Neovim is vim (lowercase Vim), not a clone or a greenfield rewrite
  • The out-of-the-box experience (for new users as well as stock installations) is very important
  • Neovim opens Pandora's box by exposing an API (the philosophical--if not technical--inverse of the Emacs approach)
  • Neovim attempts to be less prescriptive about use cases (contrary to Vim's :help design-not)

Side note:

Marketing is lame and stuff, but it's important. Spending a sliver of energy to form a competent image is an inexpensive way to gain attention on the "leaf nodes". People have finite time, and they have to make quick judgments about where they spend their attention, and even the most enlightened humans discard 99% of stimuli by quick superficial assessments simply because there is not enough time to deeply investigate everything.

Adding docs to neovim.org

@cweagans

Have you planned to add 'Docs' in the nav bar of the neovim.org website ?

Also @rjw57 made a repo with all the vim help files, perhaps we can upload those to the website (that is after converting it, as help files for neovim, and also to the required .html format) to create a sort of vimdoc.sourceforge.net ?

What do you say ? I'm happy to help you in creating the docs 😄

Move to SSL via Cloudflare

We don't have anything overly sensitive on the Neovim website, but that shouldn't stop us from enabling SSL. IIRC, we talked about moving to CloudFlare, which would also allow us to enable the Universal SSL service in the CloudFlare control panel. @jdavis, I think I recall you saying something about CloudFlare?

Add Google Analytics

I've already added the tracking code. If you'd like me to share it with you, please comment here!

[RFC] More FAQs

I think it'd be beneficial to add some more FAQs about Neovim.

I sent out a tweet to possibly gather a few more FAQs and this is what the response was:

Will Neovim enable features that apparently should be enabled (e.g. syntax highlight) by default to simplify the configuration?

Will I be able to brew install? Will neovim ever be a default install like vi is now? Finger in the air ETA on a downloadable beta?

Estimates on when we can expect a stable/usable build? A month? A year?

I've also seen a few different tweets discussing how to donate money.

Based off of this, here are a few FAQs that I came up with:

Question: What ways will we be able to install Neovim?
Answer: Neovim hopes to be available through common package managers such as Homebrew for OS X, apt-get, pacman, and yum.

Question: When will a beta be available for Neovim?
Answer: I don't have an answer for this one.

Question: Will Neovim improve upon the default configuration?
Answer: This is being discussed but the community seems to be in favor of it.

Question: I missed the Bountysource Fundraiser, can I still donate to Neovim?
Answer: The Neovim community is working with Bountysource to see if we can create a long standing donation solution. In the meantime, there's always gittip.

generate HTML/markdown from vimdocs; make available on neovim.org

User documentation should be made available on neovim.org as linkified HTML, like this but using the neovim.org theme, and the neovim-specific docs.

Only tool I could find that does this: http://vimdoc.sourceforge.net/cgi-bin/dumpvim2html.pl

Using the "html" target in the old Vim Makefile:

make html && ghp-import .

We may want to modify this script to output more disciplined HTML. Then that HTML could be fed to pandoc to open up pandora's box.

Next steps:

  • See how pandoc likes the result of dumpvim2html.pl
  • Optionally modify the output of dumpvim2html.pl to help pandoc
  • Apply neovim.org theme/CSS to generated vimdoc HTML
  • Make a build step for this, similar to doxgyen (#48)

neovim.org CNAME

The github pages help is very keen using a CNAME subdomain. But our CNAME file has neovim.org. Anyone know enough about this to comment on whether we are set up correctly?

@cweagans: does anyone else have access to the neovim.org DNS admin?

user docs: many unneeded links, some are broken

Note highlights: Python (link to the paragraph which is currently shown), Tab (links to Tab key description under :h key-notation), << (links to :h <<: command for dedenting current line).

And objects link leads to http://neovim.io/doc/user/vimindex.html#objects which shows 404.

Better looking website font

I know we’re far from done with the design and that the current font might be just temporary, but it can’t hurt to discuss it.

I propose a more readable and aesthetically pleasing font than the one currently in use, Exo 2. I find it hard to read and too «robotic». Something like Open Sans or Source Sans Pro would, in my opinion, be much better.

Newsletter vNext

Commit patterns have created high expectations:

is neovim still alive? haven't seen any updates since 4 days ago

Notable items:

  • focus on 0.1
    • roadmap
  • statement of goals/charter
  • XDG support neovim/neovim#3198
  • shada neovim/neovim#2506
  • defaults
  • third-party plugins
  • new collaborators
  • faster travis builds
  • lint for all changes going forward
  • highlight how easy it is to build neovim from source
  • jemalloc: 4.0 performance improvements
  • Neovim has driven several bug fixes in MSVC C99 support:

Needs an "Install Now" button or call-to-action on the homepage

Every time I setup a new machine, it takes me 10 minutes of clicking around to find the install instructions. It feels like the main goal of the homepage should be get me to view (and run) the install instructions, so there should be a big button or prominent link on the homepage to help accomplish that IMHO.

_posts/ not working with Jekyll

Running jekyll serve

Configuration file: /home/crackerz/Development/code/neovimWebsite/_config.yml
            Source: /home/crackerz/Development/code/neovimWebsite
       Destination: /home/crackerz/Development/code/neovimWebsite/_site
      Generating... You are missing a library required for Markdown. Please run:
  $ [sudo] gem install kramdown
  Conversion error: There was an error converting '_posts/2014-02-22-Back-Neovim-Through-Bountysource.md/#excerpt'.

             ERROR: YOUR SITE COULD NOT BE BUILT:
                    ------------------------------------
                    Missing dependency: kramdown

my temporary fix is to move _posts out of the directory before running jekyll.

merge doxygen docs to neovim.org repo

Assuming @stefan991 has interest in this, I think we should consider either linking to the doxygen docs at http://neovim.menkar.uberspace.de/devdoc or actually having his script push the latest build to this repo and hosting them on neovim.github.io.

It should be possible to modify the doxygen CSS to match the neovim branding, but it might be a pain. I know it's important to maintain a consistent look, but it's also important to provide a central channel for users in search of project materials. At the moment we're a bit scattered.

Website Design

I have started adding a little styling to the site to make it a bit more presentable for the time being (changes still pending). I used bootstrap as a base, but I am customizing a little to hopefully give it its own look and feel... though that is still a long way off.

I have also been poking around at different sites trying to get some inspiration for the design of the site. I like some elements of git's site. In particular, the logo, name, and then tagline in the top header really pop out at me. I also really like the dart lang site because it has a similar thing going on with the header plus the three side-by-side blurbs for visitors with varying interests.

I will get my current work pushed up in a bit, but would also like to start discussing what direction to take the design and layout of the site.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.