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

+10
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

-10
This file was deleted.

‎LICENSE.md

-15
This file was deleted.

‎README.md

+29
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

-21
This file was deleted.

‎_includes/head.html

-29
This file was deleted.

‎_includes/sidebar.html

-34
This file was deleted.

‎_layouts/default.html

-15
This file was deleted.

‎_layouts/page.html

-8
This file was deleted.

‎_layouts/post.html

-25
This file was deleted.

‎_posts/2013-12-28-introducing-hyde.md

-6
This file was deleted.

‎archive.html

+137
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
<!DOCTYPE HTML>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
7+
<title>Archive - Yi</title>
8+
9+
<link rel="stylesheet" type="text/css" href="./css/default.css" />
10+
11+
<!-- jQuery & jQueryUI -->
12+
<script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
13+
<script src="https://code.jquery.com/ui/1.11.3/jquery-ui.min.js"></script>
14+
<link rel="stylesheet" type="text/css" href="https://code.jquery.com/ui/1.11.3/themes/smoothness/jquery-ui.css" />
15+
16+
<!-- Pandoc Style CSS -->
17+
<link rel="stylesheet" type="text/css" href="./css/syntax.css" />
18+
19+
<!-- Bootstrap -->
20+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
21+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap-theme.min.css">
22+
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
23+
24+
<!-- TOCify -->
25+
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/javascripts/jquery.tocify.min.js"></script>
26+
<link rel="stylesheet" type="text/css" href="./css/tocify.css" />
27+
28+
</head>
29+
30+
<body>
31+
<div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
32+
<div class="container">
33+
<div class="navbar-header">
34+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
35+
<span class="sr-only">Toggle navigation</span>
36+
<span class="icon-bar"></span>
37+
<span class="icon-bar"></span>
38+
<span class="icon-bar"></span>
39+
</button>
40+
<a class="navbar-brand" href="./">Yi</a>
41+
</div>
42+
<div class="navbar-collapse collapse navbar-right">
43+
<ul class="nav navbar-nav">
44+
<!-- TODO: Take in a list and loop through it -->
45+
<li><a href="./">Home</a></li>
46+
<li><a href="./pages/about.html">About</a></li>
47+
<li><a href="./pages/installing.html">Install</a></li>
48+
<li><a href="./pages/contact.html">Contact</a></li>
49+
<li><a href="./archive.html">Archive</a></li>
50+
</ul>
51+
</div>
52+
</div>
53+
</div>
54+
55+
<div id="content" class="container">
56+
<h1>Archive</h1>
57+
58+
<h2>Posts:</h2>
59+
<ul>
60+
61+
<li>
62+
<a href="./posts/2014-09-05-oop.html">Prototypes - Encoding Object Oriented inheritance in Haskell</a> - September 5, 2014
63+
</li>
64+
65+
<li>
66+
<a href="./posts/2014-09-04-incremental-parsing.html">Incremental parsing</a> - September 4, 2014
67+
</li>
68+
69+
<li>
70+
<a href="./posts/2014-09-03-demo.html">Demo</a> - September 3, 2014
71+
</li>
72+
73+
<li>
74+
<a href="./posts/2014-09-02-configuration.html">Configuration</a> - September 2, 2014
75+
</li>
76+
77+
<li>
78+
<a href="./posts/2014-09-01-structure.html">Overall Structure</a> - September 1, 2014
79+
</li>
80+
81+
</ul>
82+
83+
84+
<h2>Pages</h2>
85+
<ul>
86+
87+
<li>
88+
<a href="./pages/about-M-x.html">About M-x/:yi</a>
89+
</li>
90+
91+
<li>
92+
<a href="./pages/about.html">About</a>
93+
</li>
94+
95+
<li>
96+
<a href="./pages/contact.html">Contact</a>
97+
</li>
98+
99+
<li>
100+
<a href="./pages/installing.html">Installing/hacking Yi</a>
101+
</li>
102+
103+
<li>
104+
<a href="./pages/modular.html">Modularizing the config</a>
105+
</li>
106+
107+
<li>
108+
<a href="./pages/problems.html">Problems with Yi</a>
109+
</li>
110+
111+
<li>
112+
<a href="./pages/reading-material.html">Reading material</a>
113+
</li>
114+
115+
<li>
116+
<a href="./pages/release-notes.html">Release notes</a>
117+
</li>
118+
119+
<li>
120+
<a href="./pages/vim-config.html">Vim configuration</a>
121+
</li>
122+
123+
<li>
124+
<a href="./pages/vimgolf.html">Vimgolf client</a>
125+
</li>
126+
127+
</ul>
128+
129+
130+
</div>
131+
<div id="footer">
132+
Site proudly generated by <a href="http://jaspervdj.be/hakyll">Hakyll</a>
133+
<p>Copyright (C) 2015, Yi developers</p>
134+
</div>
135+
136+
</body>
137+
</html>

‎atom.xml

-28
This file was deleted.

‎css/default.css

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎css/syntax.css

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)