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

_website: Document how to build the website.

Browse Source
This commit is contained in:
Qi Xiao 2018-10-21 20:49:01 +01:00
parent bc6a7b2f6c
commit 4ef1fd3883
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
_website/README.md
View File

@ -1,5 +1,14 @@
This directory contains source for Elvish's official website. They are
converted to HTML with a custom toolchain with the following dependencies:
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, notably
exceptions being 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).
@ -8,8 +17,13 @@ converted to HTML with a custom toolchain with the following dependencies:
* A Go toolchain, for building [genblog](https://github.com/xiaq/genblog)
and some custom preprocessors in the `tools` directory.
The documents are written in GitHub-flavored markdown sprinkled with some HTML
and custom macros. Most of them can be viewed directly in GitHub.
To build the website, just run `make`. The built website is in the `_dst`
directory; to preview, run an HTTP server within it.
Opening `_dst/index.html` almost works, except that browsers will show the
directories as file lists instead of using the `index.html` file, so if you
click e.g. "Learn" in the nav bar, you will need to manually click the
`index.html` within it.
# History