Linx logoLinx Docs
On this page
On this page

Integrations & API Reference

Showcase directory structures, REST endpoints, and referenced document maps.

Integrations

Integrations & API Reference

Build technical reference resources, catalog API integrations, map folder trees, and reference other guides.

1. GitHub Integration Cards

Linx Books provides static, lightweight components for displaying GitHub repositories and organizations.

GitHub Repository Card (github-repo)

liangga / linx-books
TypeScript
Modular markdown documentation platform powered by AST rendering.

GitHub Organization Card (github-org)

Flutter avatar
Flutter✓
Google's UI toolkit for building beautiful apps.
github.com/flutter

2. API Endpoints

Linx Books provides a compact, documentation-focused layout for showcasing API routes and endpoints.

GET Request (No Auth)

GET/api/v1/users

POST Request (With Auth Token)

POST/api/v1/users
Bearer

DELETE Request (Required Auth)

DELETE/api/v1/users/:id
Auth

3. Referenced Docs Component

Linx Books provides a premium, interactive component to link to other internal documentation pages or books. The metadata (title, description, and thumbnail) is resolved automatically at build-time.

Dynamic Lookup Example (Group Landing Page)

About Linx Documentation Platform banner
About Linx Documentation Platform
Welcome to Linx Books! Learn about the features, architecture, and core structure of this modern developer documentation portal.

Dynamic Lookup Example (Document Page)

Configuration
Customize metadata, thumbnails, banners, and layouts in Linx Books.

Manual Overrides Example

Customized Title Override
This description is custom-overridden in the frontmatter instead of using the resolved metadata.

Heading Lookup via Path Hash

Links directly to a heading anchor. The component automatically looks up the heading to append the correct scroll ID and suffixes the title:

Basic Components › 3. Command
Document alert banners, badge tags, and copyable terminal command widgets.

Heading Target Lookup Rules

[!NOTE] Heading Target Lookup Rules:

  1. Path-based Anchors: You target a heading solely by appending a URL hash anchor to the path (e.g. path: /path#heading-slug).
  2. Punctuation & Case Tolerance: The component slugifies both target strings, automatically ignoring dots (like 12.), spaces, case differences, and special characters.
  3. Substring Matching: Supports partial lookups. E.g., appending #command or #3-command will both successfully resolve the heading 3. Command.
  4. Failsafe Fallback: If a heading target does not exist or matches nothing on the target page, the hash parameter is ignored, and the link defaults to the document base path safely.

4. Directory & File Structure

Interactive tree-structure visualizer component supporting custom file icons, directory collapsibility, inline descriptions, and clipboard copying of the unicode tree layout.

ASCII/Text Mode Example

Paste standard ASCII or spaces directory tree output. Annotations can be added inline using comments (#, //, or <--):

App Directory Layout
linx-books
src
React source code
components
Navbar.tsx
Sidebar.tsx
App.tsx
Main entry component
main.tsx
tsconfig.json
TS compile options
package.json

YAML Items Mode Example

For custom type specification and structures, define a standard nested items list of nodes:

Src Folder Items Mode
components
Navbar.tsx
Navigation header
Sidebar.tsx
Navigation sidebar drawer
App.tsx
App entry router layout wrapper
index.css