Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation in README #504

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve documentation in README #504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,35 @@
# Sources for keycloak.org

Can be built locally from IDE by running AutoBuilder main method or with Maven by running:
Can be built locally from IDE by running `AutoBuilder` main method or with Maven by running:

mvn clean install

After the build is completed open `target/web/index.html` in your favourite web browser.

There's also an auto-builder utility that watches the filesystem and continuously rebuilds the website. This can be very useful when working on the website, especially making stylesheet changes, etc. This can be run from your IDE by running `AutoBuilder`, or from the command-line with:
```sh
KC_URL=http://localhost:8080 mvn clean install
```

mvn -Pauto-run exec:java
Once built you can serve the `target/web` directory from a local web server, for example using [http-server](https://www.npmjs.com/package/http-server):

To serve the website locally with a web browser specify the base URL with `KC_URL`:
```sh
npx http-server target/web
```

export KC_URL=http://localhost:8000
mvn install
To serve the website locally from a different domain or port you can set the base URL with the `KC_URL` environment variable.

There's also an auto-builder utility that watches the filesystem and continuously rebuilds the website. This can be very useful when working on the website, especially making stylesheet changes, etc. This can be run from your IDE by running `AutoBuilder`, or from the command-line with:

```sh
mvn -Pauto-run exec:java
```

Finally, when building the website to be published you need to include `-Dpublish`. This should usually not be done manually though as there is a GitHub Action that takes care of building and publishing to `https://github.com/keycloak/keycloak.github.io`.

## Server and Operator guides

Server and Operator guide sources are located at `https://github.com/keycloak/keycloak/tree/main/docs/guides` and are retrieved as a Maven dependency. By default the latest released version is used, but if you want to build the website with the latest guides from `main` first build the guides:

git clone https://github.com/keycloak/keycloak
cd keycloak
mvn -pl docs clean install
```sh
git clone https://github.com/keycloak/keycloak
cd keycloak
mvn -pl docs clean install
```

Then simply build the website locally with `mvn clean install`, and the locally built guides will be available in `target/web/nightly/guides.html`.
Loading