Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

gatsby-theme-patternfly-org

Package Overview
Dependencies
Maintainers
1
Versions
113
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gatsby-theme-patternfly-org

A unified PatternFly-next and PatternFly-react Gatsby theme.

  • 1.2.13
  • npm
  • Socket score

Version published
Weekly downloads
26
increased by73.33%
Maintainers
1
Weekly downloads
 
Created
Source

gatsby-theme-patternfly-org

This theme generates slugs (urls) and templated pages (mdx.js) from mdx files processed by gatsby-plugin-mdx. It generates templated fullscreen page from either Handlebars or react-live code blocks in the mdx.

Usage

We publish this theme on npm. Install it with your package manager.

npm i gatsby-theme-patternfly-org

yarn add gatsby-theme-patternfly-org

Provide or install the following dependencies:

"@patternfly/patternfly": "^2.33.5",
"@patternfly/react-core": "^3.113.0",
"@patternfly/react-icons": "^3.14.8",
"@patternfly/react-table": "^2.22.28",
"@patternfly/react-tokens": "^2.6.31",
"gatsby": "^2.6.0"

Configure your gatsby-config.js like this:

{
  resolve: `gatsby-theme-patternfly-org`,
  options: {
    context: 'org', // Default context
    hiddenPages: ['withOuia'], // By title
    sideNav: {
      core: [
        { section: 'overview' },
      ],
      react: [
        { section: 'overview' },
      ],
      get_started: [
        { text: 'About', path: '/get-started/about' },
      ],
    },
    topNavItems: [
      {
        text: 'Get started',
        path: '/get-started/about',
        contexts: ['get-started']
      },
      {
        text: 'Get in touch',
        path: '/get-in-touch'
      }
    ]
  }
},

Structure

gatsby-theme-patternfly-org
├── components
├── gatsby-config.js <- Let us use React Helmet
├── gatsby-node.js <- Pipelines GraphQL data to generate slugs and creates pages
├── gatsby-ssr.js <- Adds attributes to the static HTML
├── global.css <- 100% page height
├── helpers <- Files shared between SSR and browser
├── images
├── layouts
│   ├── sideNavLayout.css
│   └── sideNavLayout.js <- The main layout we use
├── package.json
├── pages <- Pages shared across all 3 sites
│   ├── globalCSSVariables.js
│   └── redHatFont.js
├── README.md
└── templates
    ├── fullscreen.css
    ├── fullscreenHtml.js
    ├── fullscreenMdx.js
    ├── mdx.css
    └── mdx.js <- How we render our mdx files

The highlights of this plugin are gatsby-node.js, mdx.js, and sideNavLayout.js. Each file has been documented.

FAQs

Package last updated on 18 Dec 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc