neovide/website/README.md

## Build

To build neovide’s website, ensure you have [zola](https://getzola.org/) and `awk` installed.

Then, in this directory, run:
```sh
git submodule update --init
make serve
```

## Edit

To ease maintenance, markdown files in [`content`](./content/) are often sourced from other parts of the repository, thanks to [RISS](https://cj.rs/riss). RISS allows to change the files slightly, see the [transformation reference](https://cj.rs/readme-in-static-site/#transformations-reference) for the syntax.

For instance, `content/_index.md` is sourced from the [`README`](/README.md). Thus to make changes to `content/_index.md`, edit the [`README`](/README.md) and run:
```
make md_update
```
-												Starting point for a website (#1114)

* Create a simple Zola website on a subdirectory

This uses the [Juice theme](https://www.getzola.org/themes/juice/), with
small customizations. It could be further customized later.

* Automate website content update

RISS and Makefile are used to pull the website content from various
parts of the neovide repository (reusing images and the README.md file
for instance)

* Document how to build and edit the website

It can be counter-intuitive to have to make changes outside of the
`website` directory, adding documentation and scripting clarify it.

* Deploy automatically to GitHub Pages

Uses https://github.com/marketplace/actions/zola-deploy-to-pages to
build and deploy the website on GitHub Pages.

TODO (after merging)
* A `TOKEN` need to be set as explained in https://github.com/marketplace/actions/zola-deploy-to-pages#secrets
* I’ve tested with https://cljoly.github.io/neovide/, but we need to
  change this to at least https://neovide.github.io/neovide/.

* Fix website URL

Co-authored-by: Keith Simmons <keith@the-simmons.net>
											
										
										
											3 years ago
+								## Build
 								To build neovide’s website, ensure you have [zola](https://getzola.org/) and `awk` installed.
 								Then, in this directory, run:
 								```sh
 								git submodule update --init
 								make serve
 								```
 								## Edit
 								To ease maintenance, markdown files in [`content`](./content/) are often sourced from other parts of the repository, thanks to [RISS](https://cj.rs/riss). RISS allows to change the files slightly, see the [transformation reference](https://cj.rs/readme-in-static-site/#transformations-reference) for the syntax.
 								For instance, `content/_index.md` is sourced from the [`README`](/README.md). Thus to make changes to `content/_index.md`, edit the [`README`](/README.md) and run:
 								```
 								make md_update
 								```