All Projects → cedricdelpoux → gatsby-remark-images-grid

cedricdelpoux / gatsby-remark-images-grid

Licence: MIT license
Use css grid layouts in markdown

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to gatsby-remark-images-grid

gatsby-remark-relative-images
Convert markdown image src(s) to be relative for gatsby-remark-images.
Stars: ✭ 79 (+259.09%)
Mutual labels:  remark-plugin, gatsby-plugin
remark-hint
Sprinkle hints/tips/warnings on your documents
Stars: ✭ 36 (+63.64%)
Mutual labels:  remarkjs, remark-plugin
remark-ruby
Custom syntax for remarkjs, adding ruby (furigana) to markdown.
Stars: ✭ 19 (-13.64%)
Mutual labels:  remarkjs, remark-plugin
gatsby-pantry
Gatsby Plugin Pantry 🤤
Stars: ✭ 23 (+4.55%)
Mutual labels:  gatsby-plugin
laravel-simplegrid
A simple component for generating powerful grids with Laravel.
Stars: ✭ 35 (+59.09%)
Mutual labels:  grid
react-super-styled
Responsive JSX layouts with Styled Components
Stars: ✭ 77 (+250%)
Mutual labels:  grid
gatsby-plugin-scroll-indicator
A visual indicator of page scroll on Gatsby websites
Stars: ✭ 14 (-36.36%)
Mutual labels:  gatsby-plugin
SSGS
SSGS is an easy-to-use grid system for the web. It allows you to quickly set up a responsive grid system using Sass.
Stars: ✭ 37 (+68.18%)
Mutual labels:  grid
examples
speedata Publisher examples
Stars: ✭ 25 (+13.64%)
Mutual labels:  grid
gatsby-plugin-gdpr-cookies
Gatsby plugin to add Google Analytics (V4 is supported), Google Tag Manager, Facebook Pixel, TikTok Pixel and Hotjar in a GDPR form to your site.
Stars: ✭ 88 (+300%)
Mutual labels:  gatsby-plugin
cice-playground
CICE Full Stack Web Course
Stars: ✭ 12 (-45.45%)
Mutual labels:  grid
gatsby-remark-numbered-footnotes
A small plugin to change named footnotes to numbered footnotes in your Gatsby pages using Markdown.
Stars: ✭ 15 (-31.82%)
Mutual labels:  gatsby-plugin
tk tools
Python tkinter tools, Python3.7+
Stars: ✭ 86 (+290.91%)
Mutual labels:  grid
remark-bookmarks
plugin to manage links
Stars: ✭ 15 (-31.82%)
Mutual labels:  remark-plugin
neat-components
A styled-components implementation of Thoughtbot's Neat
Stars: ✭ 32 (+45.45%)
Mutual labels:  grid
gridbugs-ru
Перевод списка багов в CSS Grid Layout, курируемого Рейчел Эндрю
Stars: ✭ 27 (+22.73%)
Mutual labels:  grid
gatsby-remark-design-system-example
Example page for "gatsby-remark-design-system"
Stars: ✭ 13 (-40.91%)
Mutual labels:  gatsby-plugin
gatsby-transformer-remark-frontmatter
Allows querying frontmatter fields as markdown with gatsby
Stars: ✭ 13 (-40.91%)
Mutual labels:  gatsby-plugin
griding
🧱 lean grid & responsive for react
Stars: ✭ 18 (-18.18%)
Mutual labels:  grid
vue-grid-responsive
Responsive grid system based on Bootstrap for Vue
Stars: ✭ 27 (+22.73%)
Mutual labels:  grid

gatsby-remark-images-grid


gatsby-remark-images-grid


Npm version Npm downloads MIT license PRs welcome


gatsby-remark-images-grid create a <figure> tag for you containing:

  • A responsive CSS grid with your images
  • A <figcaption> tag, optionally

You can, of course, choose the maximum columns number. Layout will be responsive and display less columns with small screens.

example

Getting started

gatsby-remark-images-grid

You can download gatsby-remark-images-grid from the NPM registry via the npm or yarn commands

yarn add gatsby-remark-images-grid
npm install gatsby-remark-images-grid --save

Usage

  1. Add the plugin in your gatsby-config.js file:
module.exports = {
    plugins: [
        {
            resolve: "gatsby-transformer-remark",
            options: {
                plugins: [
                    // Make CSS grids available
                    // without options
                    "gatsby-remark-images-grid"
                    // or
                    // with options
                    {
                        resolve: "gatsby-remark-images-grid",
                        options: {
                            className: "myCustomClassName",
                            gridGap: "20px",
                            margin: "20px auto",
                        },
                    },
                ],
            },
        },
    ],
}

Note: If you use others images remark plugins, put gatsby-remark-images-grid first because images are not images nodes before being wrapped by a grid

  1. Use grid layout in your markdown
  • Use the markdown code syntax
  • Use grid for the lang followed by the number of columns you want and the caption (optional) separated by a pipe (|)
```grid|2|My super images!
![](../photo1.jpg)
![](../photo2.jpg)
```

```grid|3
![](../photo3.jpg)
![](../photo4.jpg)
![](../photo5.jpg)
```

```grid|4
![](../photo6.jpg)
![](../photo7.jpg)
![](../photo8.jpg)
![](../photo9.jpg)
```

Props

Name PropType Description Default Example
className string Custom className "gatsbyRemarkImagesGrid" "myCustomClassName"
gridGap string Grid gap (horizontal and vertical) - "20px"
margin string Margin around grid - "20px auto"

Contributing

  • ⇄ Pull/Merge requests and ★ Stars are always welcome.
  • For bugs and feature requests, please create an issue.

See CONTRIBUTING.md guidelines

Changelog

See CHANGELOG.md

License

This project is licensed under the MIT License - see the LICENCE.md file for details

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].