docsifyjs / docsifyjs/docsify

Nested/Recursive includes

Open
#2,643 5 comments 0 reactions 0 assignees View on GitHub
feature request Triage
Dominant language
JavaScript
Stars
31.5k
Forks
5.8k
Avg merge
9d 8h
Merged PRs (30d)
2

Description

### Problem or Desire

For our new docs at work, we want to convert LaTeX to Markdown. The problem is that it has quite a lot of nested documents with `\include`, which Docsify can only go one level deep.

### Proposal

Docsify should resolve the included markdown files recursively. With protection against looping embeds.

### Additional Context

There is no need to make it a setting to preserve backwards compatibility.
First time

Contributor guide

Open the contributing guide

Research direction

The issue names no files, tests, or entry points. Start by locating Docsify's handling of markdown \include directives and existing embed-resolution tests; then verify recursive inclusion, including protection against looping embeds, while preserving current behavior without adding a setting.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.