@riebeckite/plugin-taxonomy 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +227 -0
- package/README_ja.md +225 -0
- package/dist/index.d.ts +34 -0
- package/dist/index.js +675 -0
- package/dist/src/collections.d.ts +17 -0
- package/dist/src/feeds.d.ts +10 -0
- package/dist/src/locations.d.ts +14 -0
- package/dist/src/options.d.ts +13 -0
- package/dist/src/pages.d.ts +9 -0
- package/dist/src/seo.d.ts +11 -0
- package/dist/src/slug.d.ts +10 -0
- package/dist/src/types.d.ts +145 -0
- package/dist/src/url.d.ts +7 -0
- package/dist/src/xml.d.ts +1 -0
- package/package.json +60 -0
- package/style.css +107 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { type ResolvedRiebeckiteConfig } from "@riebeckite/core";
|
|
2
|
+
import type { ResolvedTaxonomyOptions, TaxonomyOptions } from "./src/types.js";
|
|
3
|
+
export { buildTaxonomyIndex, serializeTaxonomyIndex, serializeTaxonomyTerm, toEntryReference, } from "./src/collections.js";
|
|
4
|
+
export { buildFeedHeadTags, renderTermFeed } from "./src/feeds.js";
|
|
5
|
+
export { resolveFolderIndexLocations } from "./src/locations.js";
|
|
6
|
+
export { DEFAULT_TAXONOMY_CLASS_NAME, DEFAULT_TAXONOMY_DATA_ENDPOINT, DEFAULT_TAXONOMY_FEED_LIMIT, DEFAULT_TAXONOMY_FOLDERS_BASE_PATH, DEFAULT_TAXONOMY_MIN_ENTRIES, DEFAULT_TAXONOMY_RELATED_LIMIT, DEFAULT_TAXONOMY_TAGS_BASE_PATH, resolveTaxonomyOptions, } from "./src/options.js";
|
|
7
|
+
export { renderRelatedTerms, renderTaxonomyPage } from "./src/pages.js";
|
|
8
|
+
export { buildTaxonomySeo } from "./src/seo.js";
|
|
9
|
+
export { slugifyTaxonomyValue } from "./src/slug.js";
|
|
10
|
+
export type { ResolvedTaxonomyOptions, TaxonomyEntryReference, TaxonomyFeedFormat, TaxonomyFeedLinks, TaxonomyFeedOptions, TaxonomyHeadTag, TaxonomyIndex, TaxonomyIndexData, TaxonomyKind, TaxonomyOptions, TaxonomyPage, TaxonomyRelatedTerm, TaxonomyTerm, TaxonomyTermContext, TaxonomyTermData, } from "./src/types.js";
|
|
11
|
+
export { buildTaxonomyAbsoluteUrl } from "./src/url.js";
|
|
12
|
+
export declare const TAXONOMY_PLUGIN_NAME = "taxonomy";
|
|
13
|
+
/**
|
|
14
|
+
* Build-time taxonomy data, per-term feeds, SEO metadata, and folder-index
|
|
15
|
+
* locations for Riebeckite.
|
|
16
|
+
*
|
|
17
|
+
* The plugin owns data, feeds, and SEO only. It does not register application
|
|
18
|
+
* routes: an app renders `/tags/<tag>` and `/folders/<path>` from the exported
|
|
19
|
+
* helpers (see the README for the documented wiring). Per-term feeds are
|
|
20
|
+
* emitted as static files through the build's generated-output sink, so no
|
|
21
|
+
* client JavaScript is required.
|
|
22
|
+
*/
|
|
23
|
+
export declare function taxonomy(options?: TaxonomyOptions): import("@riebeckite/core").RiebeckitePlugin<TaxonomyOptions>;
|
|
24
|
+
/** Alias matching the `*Plugin` suffix used by other plugin factories. */
|
|
25
|
+
export declare const taxonomyPlugin: typeof taxonomy;
|
|
26
|
+
/**
|
|
27
|
+
* Reads the taxonomy plugin's resolved options back from a Riebeckite config.
|
|
28
|
+
*
|
|
29
|
+
* App routes use this so the listing pages, feeds, and SEO they build from the
|
|
30
|
+
* exported helpers share the exact options the plugin was registered with,
|
|
31
|
+
* without duplicating the options object.
|
|
32
|
+
*/
|
|
33
|
+
export declare function resolveTaxonomyOptionsFromConfig(config: ResolvedRiebeckiteConfig): ResolvedTaxonomyOptions;
|
|
34
|
+
export type { SeoMetadata } from "@riebeckite/core";
|