Code Monkey home page Code Monkey logo

pkl-lang.org's Introduction

Pkl Documentation Website pkl-lang.org

Repo for Pkl’s documentation website.

The website is built with the Antora docsite generator out of Asciidoc docs maintained in upstream projects (pkl, pkl-spring, etc.).

Development

Releases

Releases of the website are triggered off commits to the main branch.

Install dependencies

$ ./gradlew downloadPklHtmlHighlighter 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 to preview local doc changes made to upstream projects.

$ ./gradlew buildLocalSite   # shorthand: gw bLS

Validate Docs of Local Projects

  • Validates HTML

  • Checks for dangling links

$ ./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.

$ ./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

$ ./gradlew validateRemoteSite   # shorthand: gw vRS

pkl-lang.org's People

Contributors

stackoverflow avatar bioball avatar holzensp avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.