Skip to content

Local repository import requires an extra .. in a relative file path to account for the temporary directory #79

Open
@StevenMaude

Description

@StevenMaude

It's not documented explicitly in the README that a relative file path works just as well as a URL, to import another documentation repository.

One current quirk with this is that an extra ../ seems to be required to account for the extra level of the temporary directory.

This is a simple workaround, but if this is intended as a supported feature1 and not just a hack on my part, it might be useful to:

  • either document this in the README
  • or account for the extra parent directory internally, passing the corrected path on to git clone

(Thanks for this plugin, by the way! I'm trialling it in a project I work on.)

Footnotes

  1. Working with a local checkout is useful for quicker local development and testing, instead of having to push to remote repository branches.

Activity

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

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions