Skip to content
Permalink
Browse files

;site: symlink the main README.md, render it as part of the site

The top-level README.md is usually seen when browsing github or the
cloned source - not on the website - but now we render it as part of
the website to facilitate previewing it locally (with make
site-watch).

As a side effect of symlinking it into site/, it might override site/'s
README when browsing that directory on github.

[ci skip]
  • Loading branch information...
simonmichael committed May 30, 2019
1 parent 45d62de commit 297a8313875eb8fcb684d465bc0d7bf657b6f7d0
Showing with 9 additions and 3 deletions.
  1. +1 −2 Shake.hs
  2. +7 −1 site/README
  3. +1 −0 site/README.md
@@ -224,8 +224,7 @@ main = do
,"index"
,"intro"
,"release-notes"
-- some copied from elsewhere
-- ,"README"
,"README"
,"CONTRIBUTING"
]

@@ -1,4 +1,10 @@
This is the README for the site/ directory.

(Confusingly, README.md from the parent directory is also symlinked
here, to get it rendered as part of the website, and it might take
precedence when viewing this dir on github.)

Source files for the hledger.org website.
To render this, run ./Shake website.
To generate the website, run ./Shake website.
This will add the web manuals' markdown to this directory,
render all markdown as html, and copy static files, to site/_site/.

0 comments on commit 297a831

Please sign in to comment.
You can’t perform that action at this time.