[docs] modernize markdown syntax of auto-generated README documentation #19643
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.
Checklist
bundle exec rspec
from the root directory to see all new and existing tests passbundle exec rubocop -a
to ensure the code style is validMotivation and Context
This PR modifies the behavior of the
README.md
generator (the one that generates documentation for your lanes, underfastlane/README.md
directory).Since this doc generator was written (probably haha) the markdown syntax has evolved a bit, and the generated docs don't follow markdown best practices (of leaving line breaks around headers and code snippets, for instance), causing some markdown parsers (like MacDown) to not parse them properly.
Description
I've modernized the markdown syntax, and made minor changes to the messages. I also removed manual (duplicated) fastlane installation instructions, pointing users to our latest documentation at https://docs.fastlane.tools/#installing-fastlane (which strongly suggests using
bundler
).Testing Steps
To test this branch, modify your Gemfile as:
And run
bundle install
to apply the changes.