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
3636e39179
elvish/website
History
Qi Xiao 1473fccceb Make website/ its own Go module. 
This allows us to remove toml as a dependency of the src.elv.sh module since it
is only used in the website's building process.
2021-01-28 11:02:30 +00:00
..
blog Fix typos found by codespell 2020-10-10 22:47:50 +01:00
cmd Change module import path to src.elv.sh 2021-01-27 01:30:25 +00:00
favicons website: Restructure directory. 2020-06-14 13:56:58 +01:00
get website: Move the basic style for tables into style.css, from get/prelude.css. 2020-08-31 14:31:59 +01:00
learn Small wording fix for Effective Elvish. 2020-10-10 22:47:56 +01:00
ref Add back support for circular module dependency. 2021-01-24 14:10:45 +00:00
tools Introduce "var" and "set". 2021-01-16 06:11:37 +00:00
ttyshot website/learn: Update cookbook. 2020-08-31 21:09:40 +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
go.mod Make website/ its own Go module. 2021-01-28 11:02:30 +00:00
go.sum Make website/ its own Go module. 2021-01-28 11:02:30 +00: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 website: Update Twitter handle 2021-01-27 23:53:43 +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 Fix typos found by codespell 2020-10-10 22:47:50 +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: Fix typo in CSS 2021-01-27 01:02:44 +00:00
template.html website: Add canonical URL to the generated HTML files. 2021-01-27 00:03:12 +00: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.