Add docs preview server for locally previewing documentation #2439
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✅ What’s Working
🚀 How to Use
npm run preview-docs
🎨 Features
📝 Perfect For
The server automatically converts those GitHub raw URLs (like https://raw.githubusercontent.com/Skyscanner/backpack-android/main/docs/compose/Button/screenshots/default.png) to local paths, so you can see your screenshots immediately without needing to push to GitHub first.
Just edit your markdown files, refresh the browser, and see your changes! When you’re happy with how everything looks, you can confidently push your changes. 🚀
Remember to include the following changes:
README.md
If you are curious about how we review, please read through the code review guidelines