go-sylixos/elvish
3
0
Fork 0
mirror of https://github.com/go-sylixos/elvish.git synced 2024-12-13 18:07:51 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
4f8863d609
elvish/_website
History
Qi Xiao 4f8863d609 _website: Update code in pipelines ttyshot.
2018-11-05 00:31:25 +00:00
..
_assets _website: Use an embedded subset of font awesome 4. 2018-11-05 00:23:35 +00:00
_favicons _website: Update favicon. 2018-11-04 22:19:47 +00:00
_tools _website/_tools/md-to-html: Pass a title metadata. 2018-10-16 10:19:20 +01:00
_ttyshot _website: Update code in pipelines ttyshot. 2018-11-05 00:31:25 +00:00
blog _website: Remove absolute URLs. 2018-10-21 20:49:27 +01:00
get _website: Show name of category in navbar. 2018-11-04 23:36:28 +00:00
learn _website: Remove absolute URLs. 2018-10-21 20:49:27 +01:00
ref _website: Remove absolute URLs. 2018-10-21 20:49:27 +01:00
.gitignore Move website to the _website directory. 2018-08-27 21:46:32 +01:00
home.md _website: Use an embedded subset of font awesome 4. 2018-11-05 00:23:35 +00:00
index.toml _website: Show name of category in navbar. 2018-11-04 23:36:28 +00:00
Makefile Refresh website style. 2018-11-04 19:31:11 +00:00
README.md _website: Patch relative paths ending in / when viewing locally. 2018-11-05 00:11:42 +00:00
template.html _website: Patch relative paths ending in / when viewing locally. 2018-11-05 00:11:42 +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 (download/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 ./download 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.