FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: improve showcase markdown documentation · patternfly-java/patternfly-java@45b5041 · GitHub

/ patternfly-java Public

Commit 45b5041

Browse files
hpehl
committed
docs: improve showcase markdown documentation
- Apply editorial font size to all markdown pages for better readability - Redesign home page with hero tagline, feature highlights, and getting started links - Expand get-involved page with structured sections for bugs, features, contributions - Replace hardcoded version in get-started with placeholder and Maven Central link - Fix incorrect output path references in documentation page - Add resources sections to icons and tokens concept pages
1 parent d4c1ff3 commit 45b5041

7 files changed

Lines changed: 87 additions & 11 deletions

File tree

‎showcase/markdown/concepts/icons.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,11 @@ DescriptionList dl = descriptionList()
4949
.addDescription(descriptionListDescription("2 annotations")));
5050
```
5151

52-
See also the PatternFly website about [icons](https://www.patternfly.org/design-foundations/icons#all-icons) to get an overview of the available icons.
52+
## Custom Icons
53+
54+
If you need an icon that's not included in the predefined sets, you can create a custom icon using Elemento's SVG builder API. Wrap your SVG markup in an `svg()` builder and use it wherever a `PredefinedIcon` is accepted.
55+
56+
## Resources
57+
58+
- [PatternFly icons](https://www.patternfly.org/design-foundations/icons#all-icons) — Browse all available icons on the PatternFly website
59+
- [`IconSets` Javadoc](https://patternfly-java.github.io/apidocs/org/patternfly/icon/IconSets.html) — Full API reference for predefined icon sets

‎showcase/markdown/concepts/tokens.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,8 @@ HTMLElement container = div()
4141
.style("font-size", globalFontSizeSm.var)
4242
.element();
4343
```
44+
45+
## Resources
46+
47+
- [PatternFly tokens](https://www.patternfly.org/tokens/all-patternfly-tokens) — Browse all available tokens on the PatternFly website
48+
- [`Token` Javadoc](https://patternfly-java.github.io/apidocs/org/patternfly/token/Token.html) — Full list of available token enum constants

‎showcase/markdown/developer/documentation.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ This executes `markdown.mjs`, which:
106106

107107
1. Walks the `showcase/markdown/` directory recursively
108108
2. Parses each `.md` file (frontmatter, GFM, syntax highlighting)
109-
3. Writes JSON files to `src/web/markdown/`, preserving the directory structure
110-
4. Generates `src/web/markdown/manifest.json` with the full navigation tree
109+
3. Writes JSON files to `src/web/public/markdown/`, preserving the directory structure
110+
4. Generates `src/web/public/markdown/manifest.json` with the full navigation tree
111111

112112
### JSON Output
113113

‎showcase/markdown/get-involved.md‎

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,41 @@ title: Get involved
55

66
# Get involved
77

8-
PatternFly Java is still under development. The API might change, and things might not work as expected. Please give it a try and share your feedback. Join the [chat](https://app.gitter.im/#/room/#pf4-java_core:gitter.im), enter the [discussions](https://github.com/orgs/patternfly-java/discussions) or use the GitHub [issues](https://github.com/patternfly-java/patternfly-java/issues) to report bugs or request new features.
8+
PatternFly Java is an open source project, and we welcome contributions of all kinds. Whether you want to report a bug, suggest a feature, or contribute code, there are many ways to get involved.
99

10-
Of course, you're welcome to [contribute](https://github.com/patternfly-java/patternfly-java/blob/main/CONTRIBUTING.md) to PatternFly Java. If you like what you're seeing, leave us a star!
10+
## Report Bugs
11+
12+
Found something that doesn't work as expected? Open an issue on [GitHub Issues](https://github.com/patternfly-java/patternfly-java/issues). Please include:
13+
14+
- A clear description of the problem
15+
- Steps to reproduce the issue
16+
- The expected vs. actual behavior
17+
- Your environment (Java version, GWT or J2CL, browser)
18+
19+
## Request Features
20+
21+
Have an idea for a new component or improvement? Start a conversation in [GitHub Discussions](https://github.com/orgs/patternfly-java/discussions) or open an issue with the `enhancement` label.
22+
23+
## Contribute Code
24+
25+
We'd love your help! Check out the [contributing guide](https://github.com/patternfly-java/patternfly-java/blob/main/CONTRIBUTING.md) to get started. Good first contributions include:
26+
27+
- Adding missing component variations
28+
- Improving documentation and examples
29+
- Writing tests
30+
- Fixing bugs from the issue tracker
31+
32+
## Join the Discussion
33+
34+
Connect with the community:
35+
36+
- **[GitHub Discussions](https://github.com/orgs/patternfly-java/discussions)** — Ask questions, share ideas, and discuss the project
37+
- **[Gitter](https://app.gitter.im/#/room/#pf4-java_core:gitter.im)** — Chat with the community in real time
38+
- **[GitHub Issues](https://github.com/patternfly-java/patternfly-java/issues)** — Track bugs and feature requests
39+
40+
## Stay Updated
41+
42+
- Watch the [GitHub repository](https://github.com/patternfly-java/patternfly-java) for releases and updates
43+
- Check the [changelog](https://github.com/patternfly-java/patternfly-java/blob/main/CHANGELOG.md) for recent changes
44+
45+
If you like what you're seeing, leave us a star on [GitHub](https://github.com/patternfly-java/patternfly-java)!

‎showcase/markdown/get-started.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,27 @@ title: Get started
55

66
# Get started
77

8-
PatternFly Java is available on [Maven Central](https://central.sonatype.com/search?q=g%3Aorg.patternfly). The easiest way is to import its BOM
8+
PatternFly Java is available on [Maven Central](https://central.sonatype.com/search?q=g%3Aorg.patternfly). The easiest way is to import its BOM and add a dependency for your compilation target.
9+
10+
## Maven Setup
11+
12+
Import the BOM in your `pom.xml`. Replace `${patternfly-java.version}` with the [latest version](https://central.sonatype.com/search?q=g%3Aorg.patternfly) from Maven Central:
913

1014
```xml
1115
<dependencyManagement>
1216
<dependencies>
1317
<dependency>
1418
<groupId>org.patternfly</groupId>
1519
<artifactId>patternfly-java-bom</artifactId>
16-
<version>0.9.1-SNAPSHOT</version>
20+
<version>${patternfly-java.version}</version>
1721
<type>pom</type>
1822
<scope>import</scope>
1923
</dependency>
2024
</dependencies>
2125
</dependencyManagement>
2226
```
2327

24-
and add a dependency to either
28+
Then add a dependency to either
2529

2630
```xml
2731
<dependency>

‎showcase/markdown/home.md‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@ title: PatternFly Java
55

66
# PatternFly Java
77

8-
PatternFly Java is a 💯 Java implementation of [PatternFly](https://www.patternfly.org/) without any JavaScript dependencies (except for the charts – see below). Its goal is to provide an easy-to-use, elegant, and efficient API to build complex web applications with PatternFly in Java. PatternFly Java integrates with and builds upon Elemento's [builder API](https://hal-console.gitbook.io/elemento/builder-api). It works with both GWT and J2CL. The following code snippet gives a taste of what PatternFly Java looks like:
8+
Build enterprise web applications in pure Java with [PatternFly](https://www.patternfly.org/) components — no JavaScript required.
9+
10+
PatternFly Java is a 💯 Java implementation of PatternFly that integrates with and builds upon Elemento's [builder API](https://hal-console.gitbook.io/elemento/builder-api). It works with both GWT and J2CL, giving you a type-safe, fluent API to create complex web applications entirely in Java.
11+
12+
## A Taste of the API
13+
14+
The following code snippet shows how PatternFly Java lets you build a complete page layout with just a few lines of Java:
915

1016
```java
1117
body().add(page()
@@ -38,7 +44,26 @@ body().add(page()
3844
.add("."))))));
3945
```
4046

41-
PatternFly Java aims to provide almost complete support for all components, charts, extensions, and layouts. This showcase demonstrates all currently supported components and layouts. To get all the details about using PatternFly Java, look at the [API documentation](https://patternfly-java.github.io/apidocs/).
47+
Static factory methods, method chaining, and type-safe builders make it easy to create components, compose layouts, and wire up event handlers — all with full IDE support.
48+
49+
## What You Get
50+
51+
PatternFly Java aims to provide almost complete support for PatternFly's design system:
52+
53+
- **50+ Components** — Alerts, buttons, cards, dropdowns, modals, tables, tabs, and many more. Browse the component demos in the sidebar.
54+
- **Charts** — Area, bar, donut, line, pie, and other chart types via the [`@patternfly-java/charts`](https://www.npmjs.com/package/@patternfly-java/charts) NPM package.
55+
- **Layouts** — Bullseye, flex, gallery, grid, level, split, and stack layouts for responsive page design.
56+
- **Extensions** — Code editor and finder extensions for specialized use cases.
57+
- **Design Tokens** — All PatternFly [design tokens](https://www.patternfly.org/tokens/about-tokens) available as type-safe Java enum constants.
58+
- **Icons** — FontAwesome, PatternFly, and Red Hat icon sets with convenient factory methods.
59+
60+
## Get Started
61+
62+
Ready to try PatternFly Java? Here's how to begin:
63+
64+
- **[Get started](/get-started)** — Add PatternFly Java to your Maven project
65+
- **[API documentation](https://patternfly-java.github.io/apidocs/)** — Full Javadoc reference
66+
- **[GitHub](https://github.com/patternfly-java/patternfly-java)** — Source code, issues, and discussions
4267

4368
## Charts
4469

‎showcase/src/main/java/org/patternfly/showcase/MarkdownPage.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public Iterable<HTMLElement> elements(Place place, Parameter parameter, LoadedDa
6363
MarkdownData md = data.get();
6464
removeChildrenFrom(root);
6565
root.appendChild(
66-
content().html(SafeHtmlUtils.fromSafeConstant(md.html)).element());
66+
content().editorial().html(SafeHtmlUtils.fromSafeConstant(md.html)).element());
6767
return singletonList(root);
6868
}
6969
}

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL