Add Markdown transformer #596
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This transformer adds out-of-the-box markdown support. This allows using AMP Optimizer to convert HTML documents created from Markdown files into valid AMP. A typical conversion flow would be: README.md => HTML => AMP Optimizer => valid AMP The only thing this transformer does is converting `<img>` tags into either `amp-img` or `amp-anim` tags. All other Markdown features are already supported by AMP. The transformer will try to resolve image dimensions from the actual files. Images larger than 200px will automatically get an intrinsic layout. For image detection to work, an optional dependency `probe-image-size` needs to be installed via NPM. This transformer supports the following options: - `markdown [Boolean]`: enables Markdown HTML support. Default is `false`. - `imageBasePath`: specifies a base path used to resolve an image during build, this can be a file system path or URL prefix.
sebastianbenz
force-pushed
the
markdown
branch
from
3f50625 to
5593fc8
Compare
andreban
approved these changes
Jan 31, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This transformer adds out-of-the-box markdown support. This allows
using AMP Optimizer to convert HTML documents created from Markdown
files into valid AMP. A typical conversion flow would be:
README.md => HTML => AMP Optimizer => valid AMP
The only thing this transformer does is converting
<img>tags intoeither
amp-imgoramp-animtags. All other Markdown features arealready supported by AMP. The transformer will try to resolve image
dimensions from the actual files. Images larger than 200px will automatically
get an intrinsic layout. For image detection to work, an optional dependency
probe-image-sizeneeds to be installed via NPM.This transformer supports the following options:
markdown [Boolean]: enables Markdown HTML support. Default isfalse.imageBasePath: specifies a base path used to resolve an image during build,this can be a file system path or URL prefix.