Skip to content

Latest commit

 

History

102 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


The source for the OpenWDL website: homepage, documentation, blog, get-started wizard, and brand guidelines.

The site is a React application built with Vite. Every route is prerendered to static HTML at build time and published to GitHub Pages, so the deployed site is fully static and hydrates into a client-side app on load.

Repository layout

Path Contents
site/ The website application (npm workspace @openwdl/site).
site/src/content/blog/ Blog posts, one Markdown file per post.
site/src/content/docs/ Documentation pages, compiled into routes and a search index.
site/src/routes/ The route manifest, including legacy-URL redirects.
site/public/ Static files copied verbatim into the build output.
assets/ Repository-level assets copied into site/public/assets/.

Getting started

Requires Node.js 22 or newer.

npm ci        # install dependencies (run from the repository root)
npm run dev -w @openwdl/site

dev regenerates the docs, blog route data, and search index, then starts Vite on http://localhost:5173.

Other commands

All commands run from the repository root.

npm run build:content -w @openwdl/site # regenerate docs, routes, and search data
npm run build -w @openwdl/site        # full static build into site/dist
npm test -w @openwdl/site             # unit and component tests
npm run test:static -w @openwdl/site  # assertions against the built output
npm run lint -w @openwdl/site         # eslint

The full build copies repository-level assets, regenerates content, type-checks the project, builds the client and server bundles, and prerenders the site. It honors OPENWDL_BASE for the public base path, which defaults to /.

Editing the site

See EDITING.md for how to add a blog post or a documentation page.

Deployment

Lint & Test runs on every pull request and on pushes to main.

Deploy site to Pages builds site/dist and publishes it to GitHub Pages on every push to main. It can also be started manually with workflow_dispatch. The workflow runs the unit and static-output tests as part of the build.

Contributing

  1. Open a GitHub issue describing the change.
  2. Create a branch, commit your changes, and push them.
  3. Open a pull request referencing the issue.

License

© 2026-Present The OpenWDL Developers. Available under either the MIT license, in LICENSE-MIT, or the Apache License 2.0, in LICENSE-APACHE, at your option.

About

The website for the OpenWDL organization.

Topics

Resources

Stars

2 stars

Watchers

5 watching

Forks

Releases

Packages

Used by

Contributors

Languages