2018-10-22 03:49:01 +08:00
|
|
|
This directory contains source for Elvish's official website.
|
|
|
|
|
|
|
|
|
|
The documents are written in GitHub-flavored markdown sprinkled with some HTML
|
2018-10-22 18:48:52 +08:00
|
|
|
and custom macros. Most of them can be viewed directly in GitHub; notable
|
|
|
|
|
exceptions are the homepage (`home.md`) and the download page
|
2018-11-08 08:20:44 +08:00
|
|
|
(`get/prelude.md`).
|
2018-10-22 03:49:01 +08:00
|
|
|
|
|
|
|
|
# Building
|
|
|
|
|
|
2019-12-26 23:48:14 +08:00
|
|
|
The website is a purely static one. It is built with a custom toolchain with the
|
|
|
|
|
following dependencies:
|
2018-06-06 05:03:51 +08:00
|
|
|
|
2019-12-26 23:48:14 +08:00
|
|
|
- GNU Make (any "reasonably modern" version should do).
|
2018-06-06 04:40:29 +08:00
|
|
|
|
2019-12-26 23:48:14 +08:00
|
|
|
- Pandoc 2.2.1 (other versions in the 2.x series might also work).
|
2018-06-06 04:40:29 +08:00
|
|
|
|
2019-12-26 23:48:14 +08:00
|
|
|
- A Go toolchain, for building [genblog](https://github.com/xiaq/genblog) and
|
|
|
|
|
some custom preprocessors in the `tools` directory.
|
2018-06-06 05:03:51 +08:00
|
|
|
|
2018-10-22 03:49:01 +08:00
|
|
|
To build the website, just run `make`. The built website is in the `_dst`
|
2018-11-05 08:11:42 +08:00
|
|
|
directory. You can then open `_dst/index.html` or run an HTTP server within
|
|
|
|
|
`_dst` to preview.
|
|
|
|
|
|
2019-12-26 23:48:14 +08:00
|
|
|
**NOTE**: Although the website degrades gracefully when JavaScript is disabled,
|
|
|
|
|
local viewing works best with JavaScript enabled. This is because relative paths
|
|
|
|
|
like `./get` will cause the browser to open the corresponding directory, instead
|
|
|
|
|
of the `index.html` file under it, and we use JavaScript to patch such URLs
|
|
|
|
|
dynamically.
|
2018-06-06 04:40:29 +08:00
|
|
|
|
2018-10-22 03:50:30 +08:00
|
|
|
# Commit History
|
2018-06-06 04:51:08 +08:00
|
|
|
|
2019-12-26 23:48:14 +08:00
|
|
|
These files used to live in a
|
|
|
|
|
[separate repository](https://github.com/elves/elvish.io). However, because
|
|
|
|
|
@xiaq did not merge the repositories in the correct way (he simply copied all
|
|
|
|
|
the files), the commit history is lost. Please see that repository for a full
|
|
|
|
|
list of contributors.
|
