Yi

This repository contains the documentation for the Yi text editor. The documentation is available on http://yi-editor.github.io/.

Building

The site is built with Hakyll. If you're familiar with Hakyll, you should be able to just cd into yi-documentation and proceed normally.

The source folder for the documentation is yi-documentation. Files in the top level directory are most likely Hakyll's output.

If you're not a frequent Hakyll user, you can get into a Hakyll sandboxed environment either using cabal, or using Nix. Both the cabal and nix files needed for sandboxing are attached. Once you're in the development sandbox, you can build the site using make. The makefile will automatically build the site for you, and preview it on localhost:8000

The development workflow would look like the following:

$ git clone https://github.com/yi-editor/yi-editor.github.com
$ cd yi-editor.github.com
$ cd yi-documentation
$ cabal sandbox-init
$ cabal install
$ cabal exec make

If you prefer Nix instead, just drop into a nix-shell once you're inside yi-documentation and run make.

You can get by with stack too:

stack install hakyll
stack exec make

Deploying

The output of the site is present it yi-documentation/_site. Copy the files in the output directory into the root of the github project.

mpwp/yi-editor.github.com

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages