Skip to content
Snippets Groups Projects

Issue #3335143: Update README.md file according to "README.md template"

Merged Issue #3335143: Update README.md file according to "README.md template"
6 unresolved threads
Merged Charchil Khandelwal requested to merge issue/media_opengraph-3335143:1.0.x into 1.0.x
6 unresolved threads
+ 36
23
ABOUT
-----
# Media OpenGraph
Media OpenGraph provides a new media source plugin and a default media type
using it.
This media type renders similar to pasting a link into Twitter or Facebook -
grabs the metatags/open graph tags from an external link and renders a preview
This media type renders similarly to pasting a link into Twitter or Facebook :
grabs the metatags / open graph tags from an external link and renders a preview
locally. The default media type maps an image metatag, title and description
with some very basic styling. It is expected that most sites would want to
custom style/theme.
customize the style/theme.
Example of three rendered urls:
- First with no description tag.
- Second with neither image nor description tags.
- Third with description, image and title tags.
Example of three rendered URLs:
- First with no description tag
- Second with neither image nor description tags
- Third with description, image, and title tags
![Examples](docs/examples.png)
REQUIREMENTS
------------
For a full description of the module, visit the
[project page](https://www.drupal.org/project/media_opengraph).
Drupal 9 or 10 with media enabled. Media Library is recommended.
Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/media_opengraph).
INSTALLATION
------------
Install as you would normally install a contributed Drupal module. See the
[install docs](https://www.drupal.org/docs/extending-drupal/installing-modules)
if required in the Drupal documentation for further information.
**Composer is required.**
## Table of contents
CONFIGURATION
-------------
- Requirements
- Installation
- Configuration
- Maintainers
## Requirements
The module requires Drupal 9 or 10 with the Media module enabled. Media Library
is recommended.
## Installation
Install as you would normally install a contributed Drupal module. For further
information, see
[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
## Configuration
Site builders can customize the mapping of metatags to fields by creating a
new media type or editing the default media type.
@@ -46,7 +59,7 @@ files that you've uploaded. By default data is cached for 1 week.
Advanced site builders can use non-documented metatags by manually editing and
importing config.
FAQ
---
Any questions? Ask away on the issue queue or contact the maintainer.
## Maintainers
- Nick Dickinson-Wilde - [NickDickinsonWilde](https://www.drupal.org/u/nickdickinsonwilde)
Loading