backstage / mkdocs-monorepo-plugin

✚ Build multiple documentation folders in a single Mkdocs. Designed for large codebases.
https://backstage.github.io/mkdocs-monorepo-plugin/
Apache License 2.0
314 stars 75 forks source link

Modified plugin to support wildcard include statement #66

Closed TeamTeaTime closed 2 years ago

TeamTeaTime commented 2 years ago

This is a modified plugin based on https://github.com/backstage/mkdocs-monorepo-plugin that supports new syntax to enable including all of the docs subdirectories using a wildcard syntax rather than explicitly. There is a sample project in the mkdocs-monorepo-wildcard-plugin/sample-docs folder that demonstrates the syntax.

site_name: Cats API

nav:
  - Intro: 'index.md'
  - Authentication: 'authentication.md'
  - '*include ./components/* Components': '!include .'
...

plugins:
  - monorepo