Giter Club home page Giter Club logo

Comments (1)

pawamoy avatar pawamoy commented on June 15, 2024

The issue here is that your README links to a file that is not within your docs folder (.github/CODEOWNERS), and therefore cannot be included in the final site. Since it's not included in the final site, MkDocs warns you that links from the README will be broken in the final site. Just hiding these warnings won't make the code owners page appear in the site.

The only solutions I see for you here are to:

  1. use an absolute link (instead of a relative one) to the CODEOWNER file on GitHub
  2. or maintain a copy of the CODEOWNER file in the docs folder, and link to that file from the README.

I believe there's nothing actionable here for MkDocs so I'll move this as a Q/A discussion instead.

from mkdocs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.