Skip to content

.nodocsify file to disable docsify from serving certain folders #1496

Description

@ron0studios

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)

Activity

  1. sy-records commented on Feb 8, 2021

    @sy-records
    Member

    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.

    This seems to be solved by adding basePath configuration? Can you provide a reproducible sandbox?

  2. ron0studios commented on Feb 8, 2021

    @ron0studios
    Author

    Here is the project that I am using this for https://rudrrayan.github.io/AlgoSim . I am using a separate hosting service for the iframe (itch.io) at the moment, so i think if you go back a few commits it might be there, but probably to around commit 30 or so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    wait for informationsomething is not clear, waiting for the author of the issue/pr

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions