https://github.com/carrotsearch/gatsby-transformer-html

A Gatsby transformer plugin for authoring content in HTML, part of APIdocs.
https://github.com/carrotsearch/gatsby-transformer-html

gatsby gatsby-transformer-plugin html

Last synced: 29 days ago
JSON representation

A Gatsby transformer plugin for authoring content in HTML, part of APIdocs.

• Host: GitHub
• URL: https://github.com/carrotsearch/gatsby-transformer-html
• Owner: carrotsearch
• Created: 2019-07-26T09:56:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T19:50:54.000Z (about 2 years ago)
• Last Synced: 2024-03-26T01:08:03.101Z (10 months ago)
• Topics: gatsby, gatsby-transformer-plugin, html
• Language: JavaScript
• Homepage: https://carrotsearch.github.io/apidocs/
• Size: 1.16 MB
• Stars: 9
• Watchers: 5
• Forks: 3
• Open Issues: 12
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
This repository is deprecated. The most up-to-date code is now at [@carrotsearch/gatsby-theme-apidocs](https://github.com/carrotsearch/gatsby-theme-apidocs/tree/master/plugins/gatsby-plugin-transformer-html).

---

A Gatsby transformer plugin for authoring content in HTML, part of

[`gatsby-starter-apidocs`](https://github.com/carrotsearch/gatsby-starter-apidocs).

---

One functional area of the plugin is enriching raw HTML content by:

* rewriting local links to point to the generated Gatsby pages,

* adding section anchor links,

* processing linked images into multi-resolution responsive img tags,

* applying Prism.js highlighting to code blocks,

* embedding code examples from external files,

* adding synthetic identifiers to paragraph to make it possible to link to them from content search results.

Another functional area of the plugin is extracting paragraph-sized text snippets from the page, so that they can be indexed in the client-side text search implemented by the [`gatsby-plugin-content-search`](https://github.com/carrotsearch/gatsby-plugin-content-search) plugin.

The enriched HTML and lists of extracted text snippets are available in Gatsby's GraphQL model for use by other plugins.