docsifyjs / docsifyjs/docsify

.nodocsify file to disable docsify from serving certain folders

未关闭
#1,496 2 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
wait for information
主要语言
JavaScript
星标
31.5k
派生
5.8k
平均合并
9 天 8 小时
30 天内合并 PR
2

描述

## Feature request
similar to the ".nojekyll", is it possible to include a ".nodocsify" file that prevents docsify from operating on certain folders?

#### What problem does this feature solve?
adding game or software demos using iframes. Changing the github pages from "/docs" to "/root" does not work either since it messes up docsify's system for getting _sidebar.md for some reason.

#### What does the proposed API look like?
if you include a ".nodocsify" in a folder, docsify will not operate on that folder and any of its subfolders.

#### How should this be implemented in your opinion?
I'm not entirely certain, but surely it must be possible to exclude rendering if it encounters a ".nodocsify" file?

#### Are you willing to work on this yourself?
If the solution is relatively simple, perhaps. (im not very good with javascript)

贡献指南

打开贡献指南

调研方向

Issue 中没有指定文件、测试或入口点。首先跟踪 Docsify 如何发现路由、渲染文件夹以及解析 _sidebar.md,然后确定 .nodocsify 标记会如何影响一个文件夹及其子文件夹。完成这项工作需要达成一致的行为定义,并提供覆盖被排除 demo 和普通文档文件夹的测试。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
documentation
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。