You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-1Lines changed: 10 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ Acceptable version ranges were not thoroughly tested - these versions were used
19
19
20
20
This repository consists of three branches:
21
21
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)
23
23
*`master`: the HTML content hosted under [junit-pioneer.org](http://junit-pioneer.org) as required by [GitHub organization pages][gh-org-pages]
24
24
*`site-source`: the site in source form without project-specific content
25
25
@@ -42,6 +42,15 @@ If you're on Linux, all of this can be done by calling `gradle setup`.
42
42
On Windows, you may have to run `git-setup.sh` (these are all Git commands) and then `bundle install` in `site-source`.
43
43
44
44
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
+
45
54
## Background
46
55
47
56
This setup is somewhat complex and arguably overly so.
0 commit comments