Skip to content

Commit 2a2604d

Browse files
committed
Reviewed readme
1 parent 0b93009 commit 2a2604d

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,15 @@ The Functional Java code repository is at https://github.com/functionaljava/func
1212
The process for changing or enhancing the site is:
1313

1414
* edit the source code in the `gradle` branch
15-
* generate the website
16-
* view the changes on a local server
17-
* publish the generated pages to Github
15+
* clean the build directory, run `gradlew clean`
16+
* generate the website, run `gradlew bake`, the generated files are in `build/jbake`
17+
* view the changes on a local server, run `gradlew appRun`. In a browser, go to `http://localhost:8820/`. ATM, the logo at the top of the index.html page doesn't display.
18+
* publish the generated pages to Github. Copy the files from the `gradle` branch's directory `build/jbake` to the `master` branch's root directory. Commit the files and push. You should see the changes within a few minutes at `http://www.functionaljava.org/`.
1819

19-
The website uses Gradle 2.2.1 to build, generate and publish the site and depends on JBake 2.3.1 The project uses the Gradle wrapper, so it can be run if Gradle is not installed using the `./gradlew` command. Useful gradle targets are:
20+
The website uses Gradle 4.10.2, JBake 2.3.0 and the Gradle plugin `org.jbake.site` version 1.2.0. The project uses the Gradle wrapper, so it can be run if Gradle is not installed using the `./gradlew` command. Useful gradle targets are:
2021

21-
* jbakeClean - Removes all generated files
22-
* jbake - create the website locally
23-
* jbakeServer - run the server to preview the website (accessible from http://localhost:8820)
24-
* publish - commit the website to the master branch to make available publicly accessible on the website
22+
* clean - Removes all generated files
23+
* bake - create the website locally
24+
* appRun - run the server to preview the website (accessible from http://localhost:8820)
25+
* publish - commit the website to the master branch to make available publicly accessible on the website. As of Feb 2022, publishing to Github didn't work.
2526

0 commit comments

Comments
 (0)