https://github.com/apple/pkl-lang.org
The pkl-lang.org website
https://github.com/apple/pkl-lang.org
Last synced: 3 months ago
JSON representation
The pkl-lang.org website
- Host: GitHub
- URL: https://github.com/apple/pkl-lang.org
- Owner: apple
- License: apache-2.0
- Created: 2024-01-19T17:42:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-25T00:58:42.000Z (3 months ago)
- Last Synced: 2025-03-30T21:09:55.096Z (3 months ago)
- Language: JavaScript
- Homepage: https://pkl-lang.org
- Size: 95.3 MB
- Stars: 70
- Watchers: 10
- Forks: 17
- Open Issues: 9
-
Metadata Files:
- Readme: README.adoc
- Contributing: CONTRIBUTING.adoc
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.adoc
- Security: SECURITY.adoc
Awesome Lists containing this project
README
= Pkl Documentation Website image:https://circleci.com/gh/apple/pkl-lang.org.svg?style=svg["pkl-lang.org", link="https://circleci.com/gh/apple/pkl-lang.org"]
Repo for Pkl's https://pkl-lang.org[documentation website].
The website is built with the https://antora.org[Antora] docsite generator out of https://asciidoctor.org[Asciidoc] docs maintained in upstream projects (pkl, pkl-spring, etc.).
== Development
=== Releases
Releases of the website are triggered by commits to the main branch.
=== Install dependencies
The Pkl HTML highlighter is written in Rust.
For now, this project's build configuration requires `cargo` to be installed on the local system.
[source,shell]
----
$ ./gradlew pklHtmlHighlighter npmInstall
----
=== Build Docs of Local Projects
* Takes upstream project docs from local Git repos assumed to be siblings of this repo (see _site-local.yml_).
* Builds the site (click the link printed in console output to open in browser).
This allows you to preview local doc changes made to upstream projects.
[source,shell]
----
$ ./gradlew buildLocalSite # shorthand: gw bLS
----
=== Validate Docs of Local Projects
* Validates HTML
* Checks for dangling links
[source,shell]
----
$ ./gradlew validateLocalSite # shorthand: gw vLS
----
=== Build Docs of Remote Projects
* Fetches upstream project docs from their GitHub repos (see _site-remote.yml_).
* Builds the site (click the link printed in console output to open in browser).
This is what CI runs.
[source,shell]
----
$ ./gradlew buildRemoteSite # shorthand: gw bRS
----
To run this task locally, you must have token-based access for GitHub.com setup,
=== Validate Docs of Remote Projects
* Validates HTML
* Checks for dangling links
[source,shell]
----
$ ./gradlew validateRemoteSite # shorthand: gw vRS
----