Skip to content

Fix lints in readme and other .md files #212

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
Eyas merged 9 commits into from
Mar 21, 2026
Merged

Fix lints in readme and other .md files #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8477834
Update dependencies
Eyas Mar 21, 2026
e11dcac
Update jsdoc
Eyas Mar 21, 2026
b328c39
Mark Quantity as a DataType now that it was marked as a data type in …
Eyas Mar 21, 2026
7e822ca
Update Jasmine assertions
Eyas Mar 21, 2026
a9fe886
Update naming to avoid conflicts by scoping class names by context.
Eyas Mar 21, 2026
ebbfc50
Unskip cycle test
Eyas Mar 21, 2026
48722dd
Merge branch 'main' of github.com:google/schema-dts
Eyas Mar 21, 2026
1e3ce35
Merge branch 'main' of github.com:google/schema-dts
Eyas Mar 21, 2026
56d9eb2
Fix lint issues
Eyas Mar 21, 2026
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
13 changes: 5 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,8 @@ const website: WebSite = {

### Real-world examples

Below are common patterns for using `schema-dts` types when building JSON-LD
for real websites.
Below are common patterns for using `schema-dts` types when building JSON-LD for
real websites.

#### Organization and WebSite (every site should have these)

Expand All @@ -162,10 +162,7 @@ const org: WithContext<Organization> = {
name: 'Acme Corp',
url: 'https://acme.com',
logo: 'https://acme.com/logo.png',
sameAs: [
'https://twitter.com/acme',
'https://www.linkedin.com/company/acme',
],
sameAs: ['https://twitter.com/acme', 'https://www.linkedin.com/company/acme'],
};

const site: WithContext<WebSite> = {
Expand Down Expand Up @@ -254,8 +251,8 @@ const article: WithContext<Article> = {

#### Injecting JSON-LD into HTML

When serializing JSON-LD for injection into a `<script>` tag, escape
characters that could break out of the tag or enable XSS:
When serializing JSON-LD for injection into a `<script>` tag, escape characters
that could break out of the tag or enable XSS:

```ts
function safeJsonLd(data: WithContext<Thing>): string {
Expand Down
12 changes: 6 additions & 6 deletions examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ function safeJsonLd(data: object): string {

## Svelte — `<svelte:head>`

Svelte lets you inject into `<head>` with `<svelte:head>`. Use the same
escaping pattern.
Svelte lets you inject into `<head>` with `<svelte:head>`. Use the same escaping
pattern.

```svelte
<script lang="ts">
Expand Down Expand Up @@ -161,10 +161,10 @@ document.head.appendChild(script);

## Other tooling

Some projects also pair `schema-dts` with tooling that either injects JSON-LD
at build time or generates custom Schema.org-compatible typings:
Some projects also pair `schema-dts` with tooling that either injects JSON-LD at
build time or generates custom Schema.org-compatible typings:

- [**agentmarkup**](https://github.com/agentmarkup/agentmarkup) — Vite and
Astro plugins for automatic JSON-LD injection and validation.
- [**agentmarkup**](https://github.com/agentmarkup/agentmarkup) — Vite and Astro
plugins for automatic JSON-LD injection and validation.
- [**schema-dts-gen**](https://www.npmjs.com/package/schema-dts-gen) — Generate
custom typings from any Schema.org–compatible ontology.
Loading