docsifyjs / docsifyjs/docsify

support the the `":include"` helper, or similar, for _sidebar and _navbar.

Open
#1,978 1 comment 0 reactions 0 assignees View on GitHub
enhancement needs discussion
Dominant language
JavaScript
Stars
31.5k
Forks
5.8k
Avg merge
9d 8h
Merged PRs (30d)
2

Description

## Feature request

#### What problem does this feature solve?

To include an external page, one must create a new markdown file with the `[include](//foo.com/foo ':include')` inside of it, then they can link to the local file from the sidebar. That's a lot of work.

#### What does the proposed API look like?

An update would allow us to include directly from sidebar or navbar, like so:

```markdown

- Menu:
- [Page from outside](https://outside.com/foo.md ":include")
```

This would cause the sidebar link to load the content from the outside location, and we don't need to make a wrapper file.

#### How should this be implemented in your opinion?

Need to update the sidebar and navbar compilers to support features like main compiler. The code is already duplicated twice between client renderer and server renderer, and we don't want more duplicates, so we would need to consolidate code and re-use it well.

#### Are you willing to work on this yourself?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.