mkdocs / mkdocs-redirects

Open source plugin for Mkdocs page redirects
MIT License
167 stars 25 forks source link

allow redirecting of .html URLs (without producing a warning) #51

Open boegel opened 1 year ago

boegel commented 1 year ago

(see also PR #50)

I would like to use mkdocs-redirects in our effort to port our documentation from Sphinx/.rst (hosted at ReadTheDocs to MkDocs/.md (hosted at GitHub Pages), so we can avoid breaking our current documentation URLs.

This is actually working already, by using something like:

plugins:
  - redirects:
      redirect_maps:
        en/latest/example.html: example.md

This makes a URL like https://example.github.io/docs/en/latest/exampe.html redirect correctly to https://example.github.io/docs/example/.

The problem is that mkdocs-redirects currently logs a warning for redirects of non-MarkDown paths:

WARNING  -  redirects plugin: 'en/latest/example.html' is not a valid markdown file!

That's annoying, since we would like to use mkdocs build --strict in CI to test changes to our documentation, and that exits with a non-zero exit code as soon there as any warnings.

Two potential ways forward:

boegel commented 1 year ago

@oprypin Any thoughts on this?

oprypin commented 1 year ago

Yeah this just needs to happen, even by default, I just haven't spent any time on this 😕

boegel commented 1 year ago

I'm happy to revisit my PR #50 to do this, would that help?

CommunityUBC commented 2 months ago

We would also appreciate this fix! I see that this issue is a bit old, are there any new updates on this?

We migrated from mdBook which has a similar issue. For example:

        'academics/classes/textbooks.html': 'academics/classes/textbooks.md'

The redirect works, but the warning messages make it hard to spot other legitimate warnings