go-sylixos/elvish
3
0
Fork 0
mirror of https://github.com/go-sylixos/elvish.git synced 2024-12-13 09:57:51 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
ceda0d052b
elvish/website
History
Qi Xiao ceda0d052b Update more examples to reference new slice syntax.
2020-08-17 05:34:06 +01:00
..
blog Release 0.14.1. 2020-08-16 14:40:38 +01:00
cmd website: Optimize fonts by embedding all fonts into a single CSS. 2020-06-15 00:06:28 +01:00
favicons website: Restructure directory. 2020-06-14 13:56:58 +01:00
get Release 0.14.1. 2020-08-16 14:40:38 +01:00
learn website: Make the article list of category index pages configurable. 2020-06-14 14:10:26 +01:00
ref Update more examples to reference new slice syntax. 2020-08-17 05:34:06 +01:00
tools website: Restructure directory. 2020-06-14 13:56:58 +01:00
ttyshot website: Update first ttyshot to avoid deprecated "explode". 2020-08-16 21:24:33 +01:00
.gitignore website: Optimize fonts by embedding all fonts into a single CSS. 2020-06-15 00:06:28 +01:00
fonts.css website: Optimize fonts by embedding all fonts into a single CSS. 2020-06-15 00:06:28 +01:00
gen-fonts-css.elv website: Optimize fonts by embedding all fonts into a single CSS. 2020-06-15 00:06:28 +01:00
home.css _website -> website. 2019-12-23 20:04:14 +00:00
home.js _website -> website. 2019-12-23 20:04:14 +00:00
home.md Document official Matrix room. 2020-03-20 11:24:14 +00:00
icon-font.css _website -> website. 2019-12-23 20:04:14 +00:00
index.toml website: Optimize fonts by embedding all fonts into a single CSS. 2020-06-15 00:06:28 +01:00
Makefile website: Optimize fonts by embedding all fonts into a single CSS. 2020-06-15 00:06:28 +01:00
README.md Format all Markdown files with prettier. 2019-12-26 15:48:14 +00:00
reset.css _website -> website. 2019-12-23 20:04:14 +00:00
style.css _website -> website. 2019-12-23 20:04:14 +00:00
template.html website: Optimize fonts by embedding all fonts into a single CSS. 2020-06-15 00:06:28 +01:00

README.md

This directory contains source for Elvish's official website.

The documents are written in GitHub-flavored markdown sprinkled with some HTML and custom macros. Most of them can be viewed directly in GitHub; notable exceptions are the homepage (home.md) and the download page (get/prelude.md).

Building

The website is a purely static one. It is built with a custom toolchain with the following dependencies:

  • GNU Make (any "reasonably modern" version should do).

  • Pandoc 2.2.1 (other versions in the 2.x series might also work).

  • A Go toolchain, for building genblog and some custom preprocessors in the tools directory.

To build the website, just run make. The built website is in the _dst directory. You can then open _dst/index.html or run an HTTP server within _dst to preview.

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.

Commit History

These files used to live in a separate repository. 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.