Skip to content

docs(readme): document SourceUrlResolver #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paodb merged 1 commit into from
Mar 7, 2025
Merged

docs(readme): document SourceUrlResolver #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,26 @@ The rendering process consists of the following steps:
5. Post-processing (fragment highlighting)

### Source code retrieval
The specified URL (refer to the explanation of `@DemoSource` above) will be used to fetch sources. URLs pointing to `github.com` will be rewritten into `raw.githubusercontent.com` URLs. In development mode, sources will be retrieved from the local `src` directory (if available).
The specified URL (refer to the explanation of `@DemoSource` above) will be used to fetch sources. In development mode, sources will be retrieved from the local `src` directory (if available).

By default, URLs pointing to `github.com` will be rewritten into `raw.githubusercontent.com` URLs. A custom `SourceUrlResolver` can be configured to modify this behavior.

```java
@Component
public final class SourceUrlResolverImpl implements SourceUrlResolver, VaadinServiceInitListener {

@Override
public void serviceInit(ServiceInitEvent event) {
TabbedDemo.configureSourceUrlResolver(this);
}

@Override
public Optional<String> resolveURL(TabbedDemo demo, Class<?> annotatedClass, DemoSource annotation) {
return ...;
}

}
```
### License abbreviation

A license comment block at the beginning of the file will be replaced with a short two-lines comment (author, year and link to the license terms), provided that:
Expand Down