standard-site

@atcute/standard-site

standard.site (site.standard.*) schema definitions

npm install @atcute/standard-site

usage

import { SiteStandardPublication } from '@atcute/standard-site';
import { is } from '@atcute/lexicons';

const publication: SiteStandardPublication.Main = {
	$type: 'site.standard.publication',
	name: 'my blog',
	url: 'https://example.standard.site',
};

is(SiteStandardPublication.mainSchema, publication);
// -> true

with @atcute/client

pick either one of these 3 options to register the ambient declarations

// file: tsconfig.json
{
	"compilerOptions": {
		"types": ["@atcute/standard-site"],
	},
}

// file: env.d.ts
/// <reference types="@atcute/standard-site" />

// file: index.ts
import type {} from '@atcute/standard-site';

with @atcute/lex-cli

when building your own lexicons that reference standard.site types, configure lex-cli to import from this package:

// file: lex.config.js
import { defineLexiconConfig } from '@atcute/lex-cli';

export default defineLexiconConfig({
	files: ['lexicons/**/*.json'],
	outdir: 'src/lexicons/',
	imports: ['@atcute/standard-site'],
});