go-sylixos/elvish
3
0
Fork 0
mirror of https://github.com/go-sylixos/elvish.git synced 2024-12-13 01:47:51 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
0c4691ae94
elvish/_website
History
Qi Xiao b7f11e6816 _website: Fix Elvish codeblocks.
2019-04-24 20:38:12 +01:00
..
_favicons _website: Update favicon. 2018-11-04 22:19:47 +00:00
_tools _website: Build the toc toggle button with JavaScript. 2018-11-07 14:12:58 +00:00
_ttyshot _website: Add ttyshots to fundamentals. 2018-11-17 17:17:09 +01:00
blog _website: Change download/ to get/. 2018-11-08 00:20:44 +00:00
get Make installation script fish-compatible (#807) 2019-04-06 16:05:54 +01:00
learn Fix a few typos and misspellings (#796) 2019-02-25 10:04:57 +00:00
ref _website: Fix Elvish codeblocks. 2019-04-24 20:38:12 +01:00
.gitignore Move website to the _website directory. 2018-08-27 21:46:32 +01:00
fonts.css _website/fonts.css: Use URL with versions. 2018-11-06 23:58:08 +00:00
home.css _website: Slightly simplify homepage CSS. 2018-11-08 00:12:10 +00:00
home.js _website/home.js: Make the expand button toggle expansion. 2018-11-18 17:24:34 +01:00
home.md _website: Change download/ to get/. 2018-11-08 00:20:44 +00:00
icon-font.css _website/icon-font.css: Add "font-display: swap". 2018-11-07 00:01:20 +00:00
index.toml _website: Separate reset.css. 2018-11-07 14:13:26 +00:00
Makefile _website: Add ttyshots to fundamentals. 2018-11-17 17:17:09 +01:00
README.md _website: Change download/ to get/. 2018-11-08 00:20:44 +00:00
reset.css _website: Separate reset.css. 2018-11-07 14:13:26 +00:00
style.css _website: Add ttyshots to fundamentals. 2018-11-17 17:17:09 +01:00
template.html _website: Generate nav separator with CSS. 2018-11-07 23:31:14 +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.