Skip to content

Commit 96ca606

Browse files
author
Nicolai Parlog
committed
Explain how to build site
1 parent 4947062 commit 96ca606

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Acceptable version ranges were not thoroughly tested - these versions were used
1919

2020
This repository consists of three branches:
2121

22-
* `grandmaster`: contains all branches (as [worktrees][git-worktree]) and projects (as [submodules][git-submodule] - it is the default branch
22+
* `grandmaster`: contains all branches (as [worktrees][git-worktree]) and projects (as [submodules][git-submodule] - it is the default branch)
2323
* `master`: the HTML content hosted under [junit-pioneer.org](http://junit-pioneer.org) as required by [GitHub organization pages][gh-org-pages]
2424
* `site-source`: the site in source form without project-specific content
2525

@@ -42,6 +42,15 @@ If you're on Linux, all of this can be done by calling `gradle setup`.
4242
On Windows, you may have to run `git-setup.sh` (these are all Git commands) and then `bundle install` in `site-source`.
4343

4444

45+
## Site-Building
46+
47+
After everything has been setup, running `gradle buildSite` builds the site and `gradle buildAll` includes each project's Javadoc.
48+
With the correct credentials, `gradle pushSite` pushes the changes in `site-source` to the tracked remote branch.
49+
50+
For local experimentation with the site layout, it makes sense to first run `gradle buildSite` and then manually launch Jekyll in `site-source` with `bundle exec jekyll serve`.
51+
Note the `serve`, which launches a server on localhost (Jekyll messages list the port) and also watches the `site-source` directory for further changes.
52+
53+
4554
## Background
4655

4756
This setup is somewhat complex and arguably overly so.

0 commit comments

Comments
 (0)