Skip to content

Split documentation into multiple files #1077

@aphoe

Description

@aphoe

Scribe version

5.6.0

PHP version

8.3

Laravel version

12

Scribe config

base_url => "https://dev-api.example.com"
type => "static"
theme => "elements"
auth.enabled => true
auth.default => true
examples.faker_seed => null
strategies.headers => added [
    'Knuckles\\Scribe\\Extracting\\Strategies\\StaticData',
    [
        'data' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ],
]: removed [
    'Knuckles\\Scribe\\Extracting\\Strategies\\StaticData',
    [
        'only' => [],
        'except' => [],
        'data' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ],
]
strategies.responses => added [
    'Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls',
    [
        'only' => [
            'GET *',
        ],
        'config' => [
            'app.debug' => false,
        ],
    ],
]: removed [
    'Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls',
    [
        'only' => [
            'GET *',
        ],
        'except' => [],
        'config' => [
            'app.debug' => false,
        ],
        'queryParams' => [],
        'bodyParams' => [],
        'fileParams' => [],
        'cookies' => [],
    ],
]
routeMatcher => "Knuckles\\Scribe\\Matching\\RouteMatcher"

What happened?

I have quite a number of endpoints, which makes the documentation's index.html file quite large and causes it to hang in the browser. Is there an option to split the documentation into multiple pages rather than have one big index.html?

Docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingtriage

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions