Backstage
/
mkdocs-monorepo-plugin
mirror of https://github.com/backstage/mkdocs-monorepo-plugin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Condense opening sentence in docs (#5) 

* updated README.md

* Update docs/index.md
This commit is contained in:
Bilawal Hameed 2019-10-19 16:54:33 +02:00 committed by GitHub
parent a252e28a71
commit 384e791b16
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -7,7 +7,7 @@
> **Note: This plugin is in beta.** Whilst it is not expected to significantly change in functionality, it may not yet be fully compatible with other Mkdocs configuration and thus may break with some advanced configurations. Once these have been resolved and all bugs have been ironed out, we will move this to a stable release.✏
✚ This plugin enables you to build multiple sets of documentation in a single Mkdocs. It is designed for large codebases (such as monoliths or monorepos). It was designed to address writing documentation in some of Spotify's largest codebases.
✚ This plugin enables you to build multiple sets of documentation in a single Mkdocs. It is designed to address writing documentation in Spotify's largest and most business-critical codebases (typically monoliths or monorepos).
✏️ [Blog Post](https://labs.spotify.com/2019/10/01/solving-documentation-for-monoliths-and-monorepos/) | 🐍 [Python Package](https://pypi.org/project/mkdocs-monorepo-plugin/) | ✚ [Demo](https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/) | 📕 [Docs](https://spotify.github.io/mkdocs-monorepo-plugin/)

2
docs/index.md
View File

@ -7,7 +7,7 @@
> **Note: This plugin is in beta.** Whilst it is not expected to significantly change in functionality, it may not yet be fully compatible with other Mkdocs configuration and thus may break with some advanced configurations. Once these have been resolved and all bugs have been ironed out, we will move this to a stable release.✏
✚ This plugin enables you to build multiple sets of documentation in a single Mkdocs. It is designed for large codebases (such as monoliths or monorepos). It was designed to address writing documentation in some of Spotify's largest codebases.
✚ This plugin enables you to build multiple sets of documentation in a single Mkdocs. It is designed to address writing documentation in Spotify's largest and most business-critical codebases (typically monoliths or monorepos).
✏️ [Blog Post](https://labs.spotify.com/2019/10/01/solving-documentation-for-monoliths-and-monorepos/) | 🐍 [Python Package](https://pypi.org/project/mkdocs-monorepo-plugin/) | ✚ [Demo](https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/) | 📕 [Docs](https://spotify.github.io/mkdocs-monorepo-plugin/)