Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: external a32nx repo documentation #536

Closed
wants to merge 10 commits into from

Conversation

Valastiri
Copy link
Member

@Valastiri Valastiri commented Apr 19, 2022

Summary

Courtesy Link to Section in Docs -here

Implemented a new plugin:

This allows the docs repo to pull in external markdown documentation from other FBW repositories, injects them at build, and renders it with mkdocs-material natively. Also allows for including the content in the search index natively.

A link to the pages I've included are reviewable in the link above.

Sample:

image

  • Anything above the red line is from the docs repo.
  • Everything below the red line is pulled from the A32NX repository at build and creates the table of contents from the markdown available. (can also inject specific sections only at build based on the markdown #, ## heading specified).

Location

  • docs/dev-corner/dev-guide/a32nx-repo-docs/

Discord username (if different from GitHub): Valastiri#8902

@vercel
Copy link

vercel bot commented Apr 19, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
docs ✅ Ready (Inspect) Visit Preview Apr 26, 2022 at 11:04PM (UTC)

@github-actions github-actions bot added the repo Changes to Repo or Config label Apr 19, 2022
@Valastiri Valastiri changed the title feat: external markdown support to serve docs from other FBW repos docs: external a32nx repo documentation Apr 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
repo Changes to Repo or Config
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant