Skip to content

bug: Empty pages due to MkDocs include-markdown syntax not supported by Nextra #485

@Arpit529Srivastava

Description

@Arpit529Srivastava

Describe the bug

Several documentation pages are rendering as completely blank/empty on the live site. The affected pages use MkDocs-style {% include-markdown %} Jinja2 directives which are not supported by the current Nextra (Next.js) documentation framework.

For example, visiting https://kubestellar.io/docs/contribution-guidelines/security/security-inc shows an empty page with only the navigation sidebar visible.

The source files contain syntax like:

{%
   include-markdown "../../../../SECURITY.md"
   start="<!--security-start-->"
   end="<!--security-end-->"
%}

This syntax was used by the mkdocs-include-markdown-plugin but is not recognized by Nextra, causing the pages to render with no content.

Output from KubeStellar-Snapshot.sh

N/A

Steps To Reproduce

1: Go to https://kubestellar.io/docs/contribution-guidelines/security/security-inc
2: Observe that the page is empty (no content, only navigation sidebar)
3: Check the source file at docs/content/contribution-guidelines/security/security-inc.md
See that it contains MkDocs {% include-markdown %} syntax that Nextra doesn't process

other affected files are:
/docs/contribution-guidelines/security/security_contacts-inc
/docs/contribution-guidelines/coc-inc
/docs/contribution-guidelines/onboarding-inc
/docs/contribution-guidelines/contributing-inc
/docs/contribution-guidelines/operations/code-management
/docs/Community/partners/openziti
/docs/Community/partners/fluxcd
/docs/ui-docs/ui-overview

Expected Behavior

The pages should render with their intended content. For example, the security incident response page should display the security policy and incident reporting guidelines.

Want to contribute?

  • I would like to work on this issue.

Additional Context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions