Skip to content

About

Docs as github pages for the Strata GUI framework

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Strata-Docs logo

Strata-Docs

The source of the documentation site for Strata. It is a MkDocs Material site whose Java examples are compiled and tested, and whose reference links into Javadoc built from Strata.

Path What it is
docs/ The pages: getting started, guides, platforms, reference, help and project.
src/ The code the pages include through --8<-- snippet markers, compiled and tested against Strata.

Building

Building needs JDK 25, Python 3, and the Strata and Strata-Swing checkouts beside this one, at ../Strata and ../Strata-Swing. The site documents that source: the examples compile against it, and the Javadoc is built from it.

./gradlew build
./gradlew siteJavadoc
pip install -r docs/requirements.txt
python -m mkdocs serve

./gradlew build compiles and tests the examples, and siteJavadoc builds the Javadoc into docs/javadoc. Use python -m mkdocs build --strict for a full build into site/. ./gradlew renderDocImages renders the example screens in docs/assets/images.

When Strata's API or controls change, update the matching guide or reference page here and the example in src it includes.

License

Strata-Docs is released under the Apache License, Version 2.0. See LICENSE and NOTICE.

About

Docs as github pages for the Strata GUI framework

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages