Skip to content

Commit 5890b97

Browse files
author
Siddhanathan Shanmugam
committed
Switch to Hakyll
1 parent 6467449 commit 5890b97

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+3006
-1012
lines changed

.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
# Ignore hakyll
2+
site
3+
*.o
4+
*.hi
5+
cabal.sandbox.config
6+
.cabal-sandbox
7+
_cache
8+
_site
9+
dist
10+
111
# Ignore docs files
212
_gh_pages
313
_site

.nojekyll

Whitespace-only changes.

404.html

Lines changed: 0 additions & 10 deletions
This file was deleted.

LICENSE.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Yi
2+
==
3+
4+
This repository contains the documentation for the Yi text editor. The documentation is available on [http://yi-editor.github.io/](http://yi-editor.github.io/).
5+
6+
# Building
7+
8+
The site is built with [Hakyll](https://github.com/jaspervdj/hakyll). If you're familiar with Hakyll, you should be able to just `cd` into `yi-documentation` and proceed normally.
9+
10+
The source folder for the documentation is `yi-documentation`. Files in the top level directory are most likely Hakyll's output.
11+
12+
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
13+
14+
The development workflow would look like the following:
15+
16+
~~~ bash
17+
$ git clone https://github.com/yi-editor/yi-editor.github.com
18+
$ cd yi-editor.github.com
19+
$ cd yi-documentation
20+
$ cabal sandbox-init
21+
$ cabal install
22+
$ cabal exec make
23+
~~~
24+
25+
If you prefer Nix instead, just drop into a nix-shell once you're inside `yi-documentation` and run make.
26+
27+
# Deploying
28+
29+
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.

_config.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.

_includes/head.html

Lines changed: 0 additions & 29 deletions
This file was deleted.

_includes/sidebar.html

Lines changed: 0 additions & 34 deletions
This file was deleted.

_layouts/default.html

Lines changed: 0 additions & 15 deletions
This file was deleted.

_layouts/page.html

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)