{"_id":"@bn1404/plugin-readme","name":"@bn1404/plugin-readme","dist-tags":{"latest":"0.5.1"},"versions":{"0.5.1":{"name":"@bn1404/plugin-readme","version":"0.5.1","main":"src/index.ts","types":"src/index.ts","license":"Apache-2.0","publishConfig":{"access":"public","main":"dist/index.esm.js","types":"dist/index.d.ts"},"backstage":{"role":"frontend-plugin"},"sideEffects":false,"scripts":{"start":"backstage-cli package start","build":"backstage-cli package build","lint":"backstage-cli package lint","test":"backstage-cli package test","clean":"backstage-cli package clean","prepack":"backstage-cli package prepack","postpack":"backstage-cli package postpack"},"dependencies":{"@backstage/catalog-model":"^1.4.3","@backstage/core-components":"^0.13.10","@backstage/core-plugin-api":"^1.8.2","@backstage/plugin-catalog-react":"^1.9.3","@backstage/theme":"^0.5.0","@mui/icons-material":"^5.15.7","@mui/material":"^5.15.7","react-use":"^17.2.4"},"peerDependencies":{"@emotion/react":"^11.11.3","@emotion/styled":"^11.11.0","react":"^17.0.0 || ^18.0.0"},"devDependencies":{"@backstage/cli":"^0.25.1","@backstage/core-app-api":"^1.11.3","@backstage/dev-utils":"^1.0.26","@backstage/test-utils":"^1.4.7","@testing-library/jest-dom":"6.0.0","@testing-library/react":"^14.0.0","@testing-library/user-event":"^14.0.0","msw":"^1.0.0"},"_id":"@bn1404/plugin-readme@0.5.1","gitHead":"354053235393beeb762e2015f8f9d58182fdfb94","description":"Welcome to the readme plugin!","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-zpXMjZ7j20KIYDERSA1o1fI8lsn3eCyhRnFXz3qR6own596XrEM52/WQYNoFPLSr8vVSn8BnGUdcudsI1tCiTg==","shasum":"7ffb070faa516aba09c5ec391b6284a2c3779178","tarball":"https://registry.npmjs.org/@bn1404/plugin-readme/-/plugin-readme-0.5.1.tgz","fileCount":10,"unpackedSize":26184,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDozQj+IBN1DGlEjfHtn3y6+QX3nk0St2JzFNoTVQmxlAIhAKM3whPs985EibIjj/ND+tOa49tfyS7v8OpEGG6LoVpw"}]},"_npmUser":{"name":"bn1404","email":"burakkgezer@hotmail.com"},"directories":{},"maintainers":[{"name":"bn1404","email":"burakkgezer@hotmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/plugin-readme_0.5.1_1707291177362_0.10904845769355065"},"_hasShrinkwrap":false}},"time":{"created":"2024-02-07T07:32:57.284Z","0.5.1":"2024-02-07T07:32:57.508Z","modified":"2024-02-07T07:32:57.790Z"},"maintainers":[{"name":"bn1404","email":"burakkgezer@hotmail.com"}],"description":"Welcome to the readme plugin!","license":"Apache-2.0","readme":"# Readme plugin\n\nWelcome to the readme plugin!\n\n![readme-card](https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/readme/media/readme-card.png)\n\n## Introduction\n\nThe `Readme-plugin` enables easy access and viewing of the README file. By having information such as the project's purpose, usage instructions, or installation details as a central part of the EntityPage, we hope to improve the `onboarding and understanding of entities`.\n\nThe plugin **supports all ScmIntegrations**, like Gerrit & GitLab. This makes it possible for organizations with many Source Code Integrations to use the same plugin.\n\nIt also supports various file extentions such as README.md, README.MD, README.txt, README, and README.rst.\n\n### Where can the plugin find my README file?\n\nThe README.md file is always retrieved from the same directory as the `catalog-info.yaml file`, also known as the `entity source location`. If you wish to view the path where the plugin looks for your README.md file, you can find it in the backstage.io/source-location annotation in the catalog-info.yaml file. This annotation is automatically added to your entity, so there is no need to add it manually.\n\nThe displays README files with one of the following file types: **md**, **MD**, **rst**, or **txt**. The plugin can also handle symlinks.\n\nCurrently, placing your README.md file elsewhere than in the same directory as the `catalog-info.yaml file` repository is not supported.\n\n## Readme Backend\n\nYou **need** to set up the [Readme Backend](https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/readme-backend) plugin before you move forward with any of these steps if you haven't already.\n\n## Getting started\n\n1. First, install the plugin into your app:\n\n```bash\n# From your Backstage root directory\nyarn --cwd packages/app add @axis-backstage/plugin-readme\n```\n\n2. Then, modify your entity page in `EntityPage.tsx` to include the `ReadmeCard` component that is exported from the plugin to `overviewContent``.\n\n```tsx\n// In packages/app/src/components/catalog/EntityPage.tsx\nimport { ReadmeCard } from '@axis-backstage/plugin-readme';\n\nconst overviewContent = (\n...\n  <Grid item md={6} xs={12}>\n      <ReadmeCard />\n  </Grid>\n  ...\n)\n```\n\n## Layout\n\nThe readme card is located in the overview page on the entity page. From the card header it is also possible to open a dialog displaying the full README.md.\n\n![readme-card](https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/readme/media/readme-card.png)\n\n![readme-dialog](https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/readme/media/readme-dialog.png)\n\n### Troubleshooting\n\n#### \"No README.md file found at the source location...\"\n\nThis message indicates that the backend cannot find your README.md file. Ensure that the README.md file is indeed located in the same directory as the `catalog-info.yaml file`. If you are still unable to locate it, try scheduling an entity refresh by clicking the \"Schedule Entity Refresh\" button in the AboutCard of the entity.\n","readmeFilename":"README.md"}