You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
neovide/website
Clément Joly 4424731ba4
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
..
content Starting point for a website (#1114) 3 years ago
templates Starting point for a website (#1114) 3 years ago
themes Starting point for a website (#1114) 3 years ago
.gitignore Starting point for a website (#1114) 3 years ago
Makefile Starting point for a website (#1114) 3 years ago
README.md Starting point for a website (#1114) 3 years ago
config.toml Starting point for a website (#1114) 3 years ago
riss.awk Starting point for a website (#1114) 3 years ago

README.md

Build

To build neovides website, ensure you have zola and awk installed.

Then, in this directory, run:

git submodule update --init
make serve

Edit

To ease maintenance, markdown files in content are often sourced from other parts of the repository, thanks to RISS. RISS allows to change the files slightly, see the transformation reference for the syntax.

For instance, content/_index.md is sourced from the README. Thus to make changes to content/_index.md, edit the README and run:

make md_update