Skip to content

thedemodev/patternfly-org

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

patternfly-org

The PatternFly Org is the source for the official documentation for PatternFly 3 and PatternFly 4.

Development Setup

Development setup requires yarn. If you do not already have yarn installed on your system, see https://yarnpkg.com/en/.

Build

Clone the repo and submodules:

git clone --recurse-submodules

Note: If repo is cloned without submodules, use the following commands to update submodules:

git submodule init
git submodule update

Install the site dependencies and build it using yarn:

yarn install

The packages/patternfly-3 site is generated using Jekyll. The packages/patternfly-4 site is generated using Gatsby.

Live Reload Server

A local development server can be quickly fired up for PatternFly 3 or PatternFly 4 by using either of these commands:

yarn start:pf3
yarn start:pf4

Testing production build

You can test the full production build: yarn build yarn start:prod

Deploy

The site is deployed first to a staging S3 bucket at staging.patternfly.org, and then to another bucket at patternfly.org.

Packages

No packages published

Languages

  • CSS 45.1%
  • JavaScript 42.4%
  • HTML 11.1%
  • Other 1.4%