ampli

HTML to AMP converter

Usage no npm install needed!

<script type="module">
  import ampli from 'https://cdn.skypack.dev/ampli';
</script>

README

AMPLI

Build Status codecov FOSSA Status

HTML to AMP tranformer

Usage

Install via NPM or yarn.

In your application your can call Ampli like this

import * as log from "log"
import Ampli, { ContextInterface, OptionsInterface } from "ampli"

const options: OptionsInterface | null = {
  //...
}
const additionalDecorators: Function[] | null = [(document: ContextInterface, options: OptionsInterface) => document]

const additionalDecoratorsBefore: Function[] | null = [(document: ContextInterface, options: OptionsInterface) => document]
const html: string = "" //...

const ampli: Ampli = new Ampli(options, additionalDecorators, additionalDecoratorsBefore)
const amp: string = await ampli.transform(html)

log.info(amp)

Options

  • logger?: LoggerInterface, use this object as logger instance, default log
  • useStaticCss?: boolean, remove CSS that is not used, default: false
  • additionalTags?: string[], custom HTML-tags that should be left in code
  • additionalScripts?: AdditionalScriptsInterface[], additional scripts from AMP
  • baseUrl?: string, a static URL to prefix relative file paths with

Constrains

You must provide fully qualified URLs for images, stylesheets.

TODO

  • Make it possible to prefix relative URLs automatically with specific URL
  • Add mechanism to include canonical tag
  • Fix SVG requests

License

This project is under MIT license.

FOSSA Status