@tsdoctor/pages 0.1.0

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/index.js ADDED
@@ -0,0 +1,12 @@
1
+ import { AvailableFrom, BaseClass, Block, CodeText, EnumMemberRow, EnumMemberTable, Example, ExampleGroup, Inline, Member, MemberGroup, MemberIndex, MemberIndexEntry, MemberRole, ParameterRow, ParameterTable, Prose, ProseBlock, ProseRole, ReleaseTag, SeeAlso, Signature, SourceLink, Title } from "./Blocks.js";
2
+ import { classifyCutDirective, isTwoslashDirective } from "./TwoslashDirectives.js";
3
+ import { ExampleFormatError, addLogicalBlankLines, buildExample, codeText, formatExampleCode, prepareExampleCode, prependHiddenImports, stripTwoslashDirectives } from "./Examples.js";
4
+ import { NAV_INDEX_LABEL, NavCategory, NavEntry, NavGroup, NavPage, NavTree, buildNav, sortNavPages } from "./Nav.js";
5
+ import { Page, PageKind } from "./Page.js";
6
+ import { INDEX_PAGE_TITLE, IndexPage, NO_DESCRIPTION, buildIndexPage, buildPage, isPageKind } from "./Build.js";
7
+ import { filterLlmsFullTxt, filterLlmsTxt, generatePackageLlmsFullTxt, generatePackageLlmsTxt, generateStructuredLlmsTxt, parseLlmsTxtLine } from "./Llms.js";
8
+ import { markdownBlockTree, markdownTree, renderMarkdown, renderMarkdownResult } from "./Markdown.js";
9
+ import { apiScopeOf, normalizeBaseRoute, unscopedName } from "./Scope.js";
10
+ import { crossLinkKindPriority, prepareWorkItems } from "./WorkItems.js";
11
+
12
+ export { AvailableFrom, BaseClass, Block, CodeText, EnumMemberRow, EnumMemberTable, Example, ExampleFormatError, ExampleGroup, INDEX_PAGE_TITLE, IndexPage, Inline, Member, MemberGroup, MemberIndex, MemberIndexEntry, MemberRole, NAV_INDEX_LABEL, NO_DESCRIPTION, NavCategory, NavEntry, NavGroup, NavPage, NavTree, Page, PageKind, ParameterRow, ParameterTable, Prose, ProseBlock, ProseRole, ReleaseTag, SeeAlso, Signature, SourceLink, Title, addLogicalBlankLines, apiScopeOf, buildExample, buildIndexPage, buildNav, buildPage, classifyCutDirective, codeText, crossLinkKindPriority, filterLlmsFullTxt, filterLlmsTxt, formatExampleCode, generatePackageLlmsFullTxt, generatePackageLlmsTxt, generateStructuredLlmsTxt, isPageKind, isTwoslashDirective, markdownBlockTree, markdownTree, normalizeBaseRoute, parseLlmsTxtLine, prepareExampleCode, prepareWorkItems, prependHiddenImports, renderMarkdown, renderMarkdownResult, sortNavPages, stripTwoslashDirectives, unscopedName };
package/package.json ADDED
@@ -0,0 +1,54 @@
1
+ {
2
+ "name": "@tsdoctor/pages",
3
+ "version": "0.1.0",
4
+ "private": false,
5
+ "description": "Framework-neutral documentation page IR for static TypeScript API sites: typed doc blocks over an API Extractor model, per-API navigation trees, display/source code preparation, a plain-markdown emitter and the llms.txt text transforms.",
6
+ "keywords": [
7
+ "api-extractor",
8
+ "tsdoc",
9
+ "documentation",
10
+ "markdown",
11
+ "mdast",
12
+ "llms",
13
+ "typescript",
14
+ "effect"
15
+ ],
16
+ "homepage": "https://github.com/spencerbeggs/tsdoctor#readme",
17
+ "bugs": {
18
+ "url": "https://github.com/spencerbeggs/tsdoctor/issues"
19
+ },
20
+ "repository": {
21
+ "type": "git",
22
+ "url": "git+https://github.com/spencerbeggs/tsdoctor.git",
23
+ "directory": "packages/pages"
24
+ },
25
+ "license": "MIT",
26
+ "author": {
27
+ "name": "C. Spencer Beggs",
28
+ "email": "spencer@beggs.codes",
29
+ "url": "https://spencerbeg.gs"
30
+ },
31
+ "sideEffects": false,
32
+ "type": "module",
33
+ "exports": {
34
+ ".": {
35
+ "types": "./index.d.ts",
36
+ "import": "./index.js",
37
+ "default": "./index.js"
38
+ },
39
+ "./package.json": "./package.json"
40
+ },
41
+ "dependencies": {
42
+ "@microsoft/api-extractor-model": "^7.33.11",
43
+ "@tsdoctor/model": "0.6.0",
44
+ "@tsdoctor/seo": "0.1.1",
45
+ "prettier": "^3.9.6"
46
+ },
47
+ "peerDependencies": {
48
+ "@effected/markdown": "^0.8.0",
49
+ "effect": "4.0.0-rc.109"
50
+ },
51
+ "engines": {
52
+ "node": ">=24.11.0"
53
+ }
54
+ }
@@ -0,0 +1,11 @@
1
+ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
+ // It should be published with your NPM package. It should not be tracked by Git.
3
+ {
4
+ "tsdocVersion": "0.12",
5
+ "toolPackages": [
6
+ {
7
+ "packageName": "@microsoft/api-extractor",
8
+ "packageVersion": "7.59.0"
9
+ }
10
+ ]
11
+ }