Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ This repository contains the source for the neovim.io website.

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

To embed raw html:

{{< rawhtml >}}
<lol>
{{< /rawhtml >}}

## Setup

This site is statically generated using Hugo. It takes one minute to get setup,
Expand All @@ -33,8 +27,11 @@ just do the following:

Notes:

- www.neovim.io/doc is served by https://github.com/neovim/doc (which previously
crawled neovim.io/doc2 generated from this repository).
- Updating `content/doc2/` currently requires a human to run: `./sync_docs.sh`
- Files in `content/doc2/` are synced to https://github.com/neovim/doc/ by
[this CI job](https://github.com/neovim/doc/blob/4ab2e06af98dadbd35c4282c1b18304d87f8eb59/ci/doc-index.sh#L10-L13).
- This is because `neovim.io/doc/` is served by https://github.com/neovim/doc/
(where the user documentation HTML is published).
- Site search (for `:help` docs) is served by [Algolia Docsearch](https://docsearch.algolia.com/).
- The javascript and UI container were setup in [this commit](https://github.com/neovim/neovim.github.io/commit/ce9aef12eb1c98135965e3a9c5c792bf9e506a76).
- The docs pages don't use the layout so they also need to [manually include](https://github.com/neovim/neovim/pull/23839) the javascript and define a UI container.
Expand Down
24 changes: 0 additions & 24 deletions content/community.md

This file was deleted.

8 changes: 4 additions & 4 deletions content/doc2/index.html → content/doc2/_index.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Documentation
active: Documentation
type: default
layout: single
---

<section class="front-section">
Expand All @@ -12,10 +12,10 @@ <h1>Documentation</h1>
<div>
<h2>User</h2>

<h3><a href="https://github.com/neovim/neovim/blob/master/INSTALL.md">Install</a></h3>
<h3><a href="/doc/install">Install</a></h3>
<p>
<a href="https://github.com/neovim/neovim/releases">Download a binary</a>
or use a <a href="https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-package">package manager</a>.
or use a <a href="/doc/install#install-from-package">package manager</a>.
</p>

<h3>
Expand All @@ -37,7 +37,7 @@ <h2>Developer</h2>

<h3>Resources</h3>
<ul>
<li><a href="https://github.com/neovim/neovim/blob/master/BUILD.md">Building Nvim from source</a></li>
<li><a href="/doc/build">Building Nvim from source</a></li>
<li><a href="https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md">Contributing to Neovim</a></li>
<li><a href="https://neovim.io/doc/user/dev.html#dev"><code>:help dev</code></a> guidelines and design constraints</li>
<li><a href="https://neovim.io/doc/user/dev_tools.html#dev-tools"><code>:help dev-tools</code></a> tools and techniques</li>
Expand Down
Loading