+ Screenshot of Neovide running on Windows
+
-
+This is a simple graphical user interface for [Neovim](https://github.com/neovim/neovim) (an
+aggressively refactored and updated Vim editor). Where possible there are some graphical
+improvements, but functionally it should act like the terminal UI.
-I've been using this as my daily driver since November 2019. It should be relatively stable, but I'm still working out some kinks
-and ironing out some cross platform issues. In general it should be usable at this point, and if it isn't I consider that a bug and
-appreciate a report in the issues! Any help and ideas are also greatly appreciated.
+To checkout all the **cool features**, **installation instructions**, **configuration settings** and
+much more, head on over to [neovide.dev](https://neovide.dev).
-I'm also very interested in suggestions code quality/style wise when it comes to Rust. I'm pretty new to the language and appreciate
-any critiques that you might have to offer. I won't take all of them, but I promise to consider anything you might have to offer.
+
+ Screenshot of Neovide running on Windows
+
This folder is the
+source of documentation for Neovide, a simple no-nonsense, cross-platform, graphical editor for
+Neovim, hosted on [neovide.dev](https://neovide.dev)
-Then, in this directory, run:
-```sh
-git submodule update --init
-make serve
-```
+_Note: If you're looking for the Neovide source code, that can be found
+[here](https://github.com/neovide/neovide)_
-## Edit
+
+ Screenshot of Landing Page
+
+ 
+
+ 
+
+ 
+
+ 
+
+
+```vim
+let g:neovide_cursor_vfx_mode = "railgun"
+```
+
+#### Torpedo
+
+
+
+```vim
+let g:neovide_cursor_vfx_mode = "torpedo"
+```
+
+#### Pixiedust
+
+
+
+```vim
+let g:neovide_cursor_vfx_mode = "pixiedust"
+```
+
+#### Sonic Boom
+
+
+
+```vim
+let g:neovide_cursor_vfx_mode = "sonicboom"
+```
+
+#### Ripple
+
+
+
+```vim
+let g:neovide_cursor_vfx_mode = "ripple"
+```
+
+#### Wireframe
+
+
+
+```vim
+let g:neovide_cursor_vfx_mode = "wireframe"
+```
+
+### Particle Settings
+
+Options for configuring the particle generation and behavior.
+
+#### Particle Opacity
+
+```vim
+let g:neovide_cursor_vfx_opacity=200.0
+```
+
+Sets the transparency of the generated particles.
+
+#### Particle Lifetime
+
+```vim
+let g:neovide_cursor_vfx_particle_lifetime=1.2
+```
+
+Sets the amount of time the generated particles should survive.
+
+#### Particle Density
+
+```vim
+let g:neovide_cursor_vfx_particle_density=7.0
+```
+
+Sets the number of generated particles.
+
+#### Particle Speed
+
+```vim
+let g:neovide_cursor_vfx_particle_speed=10.0
+```
+
+Sets the speed of particle movement.
+
+#### Particle Phase
+
+```vim
+let g:neovide_cursor_vfx_particle_phase=1.5
+```
+
+Only for the `railgun` vfx mode.
+
+Sets the mass movement of particles, or how individual each one acts. The higher the value, the less
+particles rotate in accordance to each other, the lower, the more line-wise all particles become.
+
+#### Particle Curl
+
+```vim
+let g:neovide_cursor_vfx_particle_curl=1.0
+```
+
+Only for the `railgun` vfx mode.
+
+Sets the velocity rotation speed of particles. The higher, the less particles actually move and look
+more "nervous", the lower, the more it looks like a collapsing sine wave.
diff --git a/website/docs/editing-with-external-tools.md b/website/docs/editing-with-external-tools.md
new file mode 100644
index 0000000..f5d513f
--- /dev/null
+++ b/website/docs/editing-with-external-tools.md
@@ -0,0 +1,18 @@
+# Editing w/ External Tools
+
+You can use Neovide in other programs as editor, this page aims to document some quirks. Support for
+that, however, is only possible as far as reasonably debuggable.
+
+_Note: We do not endorse nor disrecommend usage of all programs listed here. All usage happens on
+your own responsibility._
+
+## [jrnl](https://github.com/jrnl-org/jrnl)
+
+In your configuration file:
+
+```yaml
+editor: "neovide --nofork"
+```
+
+...as `jrnl` saves & removes the temporary file as soon as the main process exits, which happens
+before startup by [forking](
+
+## Animated Cursor
+
+Cursor animates into position with a smear effect to improve tracking of cursor position.
+
+
+
+## Smooth Scrolling
+
+Scroll operations on buffers in neovim will be animated smoothly pixel wise rather than line by line
+at a time.
+
+Note: [multigrid](command-line-reference.md#multigrid) must be enabled for this to work.
+
+
+
+## Animated Windows
+
+Windows animate into position when they are moved making it easier to see how layout changes happen.
+
+Note: [multigrid](command-line-reference.md#multigrid) must be enabled for this to work.
+
+
+
+## Blurred Floating Windows
+
+The backgrounds of floating windows are blurred improving the visual separation between foreground
+and background from built in window transparency.
+
+Note: [multigrid](command-line-reference.md#multigrid) must be enabled for this to work.
+
+
+
+## Emoji Support
+
+Font fallback supports rendering of emoji not contained in the configured font.
+
+
+
+## WSL Support
+
+Neovide supports displaying a full gui window from inside wsl via the `--wsl` command argument.
+Communication is passed via standard io into the wsl copy of neovim providing identical experience
+similar to Visual Studio Code's
+[Remote Editing](https://code.visualstudio.com/docs/remote/remote-overview).
+
+## Remote TCP Support
+
+Neovide supports connecting to a remote instance of Neovim over a TCP socket via the `--remote-tcp`
+command argument. This would allow you to run Neovim on a remote machine and use the GUI on your
+local machine, connecting over the network.
+
+Launch Neovim as a TCP server (on port 6666) by running:
+
+```sh
+nvim --headless --listen localhost:6666
+```
+
+And then connect to it using:
+
+```sh
+/path/to/neovide --remote-tcp=localhost:6666
+```
+
+By specifying to listen on localhost, you only allow connections from your local computer. If you
+are actually doing this over a network you will want to use SSH port forwarding for security, and
+then connect as before.
+
+```sh
+ssh -L 6666:localhost:6666 ip.of.other.machine nvim --headless --listen localhost:6666
+```
+
+Finally, if you would like to leave the neovim server running, close the neovide application window
+instead of issuing a `:q` command.
+
+## Some Nonsense ;)
+
+To learn how to configure the following, head on over to the
+[configuration](./configuration.md#cursor-particles) section!
+
+### Railgun
+
+
+
+### Torpedo
+
+
+
+### Pixiedust
+
+
+
+### Sonic Boom
+
+
+
+### Ripple
+
+
+
+### Wireframe
+
+
diff --git a/website/docs/index.md b/website/docs/index.md
new file mode 100644
index 0000000..f538574
--- /dev/null
+++ b/website/docs/index.md
@@ -0,0 +1,65 @@
+
+
+
+
+
+
+This is a simple, no-nonsense, cross-platform graphical user interface for
+[Neovim](https://github.com/neovim/neovim) (an aggressively refactored and updated Vim editor).
+Where possible there are some graphical improvements, but functionally it should act like the
+terminal UI.
+
+
+
+If you're looking for the Neovide source code, that can be found
+[here](https://github.com/neovide/neovide). To search within the docs, you can simply press `s` or
+click the magnifying glass icon in the top left to bring up the search bar.
+
+Installing through a package manager or building from source? [no problem!](installation.md)
+
+Want to see a list of all the available features? [here you go!](features.md)
+
+Looking to configure your neovide? [we've got you covered!](configuration.md)
+
+
+ Screenshot of Neovide running on Windows
+
+ Neovide
+ 
+ 
+