Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
276bf9a
docs: moving docs to 11ty
kylebuch8 Mar 2, 2021
0149233
Branch was auto-updated with the latest.
github-actions[bot] Mar 2, 2021
3a0cb98
updating to v1.3.3 of PatternFly Elements
kylebuch8 Mar 22, 2021
719c09d
updating documentation footer link
kylebuch8 Mar 22, 2021
d67f949
Update README.md
castastrophe Mar 30, 2021
847de97
fork: 11ty updates; scripting assist (#1508)
castastrophe Apr 8, 2021
ee2dea4
Merge branch 'master' into updated-site
kylebuch8 Apr 8, 2021
bef804d
Merge branch 'master' into updated-site
kylebuch8 Apr 8, 2021
e26359d
Alias deploy-docs script to build-docs
castastrophe Apr 8, 2021
38ba3c5
Ignore node_modules on the docs directory
castastrophe Apr 8, 2021
483acee
Branch was auto-updated with the latest.
github-actions[bot] Apr 9, 2021
0cac08e
Branch was auto-updated with the latest.
github-actions[bot] Apr 9, 2021
5fd4b1a
Branch was auto-updated with the latest.
github-actions[bot] Apr 12, 2021
d7827c9
Branch was auto-updated with the latest.
github-actions[bot] Apr 13, 2021
24932a4
Merge branch 'master' of github.com:patternfly/patternfly-elements in…
castastrophe Apr 14, 2021
5c0f1d0
Merge branch 'master' into updated-site
castastrophe Apr 14, 2021
b16bac1
Branch was auto-updated with the latest.
github-actions[bot] Apr 14, 2021
460aba4
Merge branch 'master' into updated-site
castastrophe Apr 14, 2021
9034fb7
Branch was auto-updated with the latest.
github-actions[bot] Apr 14, 2021
56598c2
Add storybook assets to the publish directory; update spandx localhos…
castastrophe Apr 15, 2021
93fdc85
Resolve assets missing from site during build
castastrophe Apr 15, 2021
f8f8265
Update reference to brand assets
castastrophe Apr 15, 2021
5a8040e
Update package to resolve warnings in console
castastrophe Apr 15, 2021
03b39b7
Update all demo pages to source requirejs from a cdn instead of as a …
castastrophe Apr 15, 2021
5c46aaa
Update node modules references to use locally built components
castastrophe Apr 15, 2021
35e0028
Updating referencing to CDNs
castastrophe Apr 15, 2021
f9c0207
Remove travis config
castastrophe Apr 15, 2021
f000cb0
Remove storybook copy as it's built to the docs directory now
castastrophe Apr 15, 2021
fce4b2e
Branch was auto-updated with the latest.
github-actions[bot] Apr 15, 2021
740eb4e
Branch was auto-updated with the latest.
github-actions[bot] Apr 15, 2021
9679268
Branch was auto-updated with the latest.
github-actions[bot] Apr 15, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 8 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<!-- Suggest linking to Netlify or a public sandbox; not a resource behind a log-in or VPN -->
Link(s) to demo page(s) where this element can be viewed:
- [Link](https://deploy-preview-<pr_number>--happy-galileo-ea79c4.netlify.app//examples/)
- [Link](https://deploy-preview-<pr_number>--happy-galileo-ea79c4.netlify.app/examples/)


### What has changed and why
Expand All @@ -32,7 +32,12 @@ Link(s) to demo page(s) where this element can be viewed:

<!-- Be sure to include detailed instructions on how your update can be tested by another developer. -->

1.
- [ ] *Test case #1*
1. Go here
2. Do this
- [ ] *Test case #2*
1. Go here
2. Do this


#### Browser requirements
Expand All @@ -42,7 +47,7 @@ Your component should work in all of the following environments:
- [ ] Latest 2 versions of Edge
- [ ] Internet Explorer 11 (should be useable, not pixel perfect)
- [ ] Latest 2 versions of Firefox (one on Mac OS, one of Windows OS)
- [ ] Firefox 68 (or latest version for Red Hat Enterprise Linux distribution)
- [ ] Firefox 78 (or latest version for Red Hat Enterprise Linux distribution)
- [ ] Latest 2 versions of Chrome (one on Mac OS, one of Windows OS)
- [ ] Latest 2 versions of Safari
- [ ] Android mobile device (such as the Galaxy S9)
Expand All @@ -57,7 +62,6 @@ Your component should work in all of the following environments:
- [ ] Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
- [ ] Tests have been updated to cover these changes.
- [ ] Browser testing passed.
- [ ] Repository compiles and tests pass.
- [ ] Changelog updated.
- [ ] Documentation (README.md, WHY.md, etc.) updated or added.
- [ ] Link to the demo recording: []()
Expand Down
3 changes: 1 addition & 2 deletions .github/PULL_REQUEST_TEMPLATE/new_component.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A brand new web component!

<!-- Suggest linking to Netlify or a public sandbox; not a resource behind a log-in or VPN -->
Link(s) to demo page(s) where this element can be viewed:
- [Link](https://5e6089f7c8e38b0008963801--happy-galileo-ea79c4.netlify.com/examples/)
- [Link](https://deploy-preview-<pr_number>--happy-galileo-ea79c4.netlify.app/examples/)


### What has changed and why
Expand Down Expand Up @@ -57,7 +57,6 @@ Check off items as they are completed. Feel free to delete items if they are no
- [ ] Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
- [ ] Tests have been updated to cover these changes.
- [ ] Browser testing passed.
- [ ] Repository compiles and tests pass.
- [ ] Changelog updated.
- [ ] Documentation (README.md, WHY.md, etc.) updated or added.
- [ ] Link to the demo recording: []()
Expand Down
5 changes: 2 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE/update_component.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Updates relating to a specific component(s).

<!-- Suggest linking to Netlify or a public sandbox; not a resource behind a log-in or VPN -->
Link(s) to demo page(s) where this element can be viewed:
- [Link](https://5e6089f7c8e38b0008963801--happy-galileo-ea79c4.netlify.com/examples/)
- [Link](https://deploy-preview-<pr_number>--happy-galileo-ea79c4.netlify.app/examples/)


### What has changed and why
Expand All @@ -39,7 +39,7 @@ Your component should work in all of the following environments:
- [ ] Latest 2 versions of Edge
- [ ] Internet Explorer 11 (should be useable, not pixel perfect)
- [ ] Latest 2 versions of Firefox (one on Mac OS, one of Windows OS)
- [ ] Firefox 68 (or latest version for Red Hat Enterprise Linux distribution)
- [ ] Firefox 78 (or latest version for Red Hat Enterprise Linux distribution)
- [ ] Latest 2 versions of Chrome (one on Mac OS, one of Windows OS)
- [ ] Latest 2 versions of Safari
- [ ] Android mobile device (such as the Galaxy S9)
Expand All @@ -54,7 +54,6 @@ Check off items as they are completed. Feel free to delete items if they are no
- [ ] Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
- [ ] Tests have been updated to cover these changes.
- [ ] Browser testing passed.
- [ ] Repository compiles and tests pass.
- [ ] Changelog updated.
- [ ] Documentation (README.md, WHY.md, etc.) updated or added.
- [ ] Link to the demo recording: []()
Expand Down
1 change: 0 additions & 1 deletion .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
demo:
- examples/*
- elements/*/demo/*

generator:
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/label.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:
pull_request:
types: [opened, synchronize]
# paths:
# - examples/*
# - elements/*/demo/*
# - generators/**/*
# - docs/**/*
Expand Down
18 changes: 7 additions & 11 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,6 @@ elements/*/dist
elements/*/__*.scss
elements/*/package-lock.json

# Demo URL
examples/index.html

# Compiled index
doc/index.html

# Logs
lerna-debug.log
npm-debug.log*
Expand Down Expand Up @@ -48,14 +42,16 @@ test/.wct-kludge
*~
*.swp

# Kube assets
docs/resources/_gen/assets
# Documentation
/docs/_site
/docs/components/*/
/docs/node_modules/
/docs/examples/index.html
/docs/storybook

# E2E
/test/vrt-snapshots/
/test/vrt-results/

# Storybook
storybook

# Sassdoc compiled assets ignored
elements/pfe-sass/demo/*
22 changes: 0 additions & 22 deletions .travis.yml

This file was deleted.

33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,14 @@ npm run storybook
The storybook script will launch the interactive demo pages.

### Additional dependencies
If you will be doing any release work, it is recommended that you install Hugo and Hub.
If you will be doing any release work, it is recommended that you install Hub.

To install on a MacOS: `brew install hugo hub`.
To install on a MacOS: `brew install hub`.

For other systems, please see documentation:
- [Hub](https://hub.github.com/)
- [Hugo](https://gohugo.io/getting-started/quick-start/)

_Note: You will need to use [Node](https://nodejs.org/en/) v.7 or higher._
_Note: You will need to use [Node](https://nodejs.org/en/) v10 or higher._

## Command Line Helper Scripts
Many commands have an optional argument of space-separated component name(s), if left off it will assume it should run on all components. These should run from the project root.
Expand Down Expand Up @@ -65,9 +64,6 @@ npm run dev

# Runs storybook preview tool
npm run storybook

# Open documentation
npm run docs
```

### Testing
Expand All @@ -92,9 +88,20 @@ The test command can accept a flags; for more details, use `npm run test -- --he
npm run pr
```

### Documentation site
View the documentation locally
```shell
npm run start-docs
```

Build the documentation site
```shell
npm run build-docs
```

## Support

Though we have tested and verified general usability within these frameworks, PFE makes no guarantees about compatibility within specific sites & applications. Please test accordingly. For more details, check out the [official status card per component](https://github.com/patternfly/patternfly-elements/issues?q=is%3Aopen+is%3Aissue+label%3A%22status+tracking+only%22) or visit the [status page on the documentation site](https://patternfly.github.io/patternfly-elements/getting-started/component-status/).
Though we have tested and verified general usability within these frameworks, PFE makes no guarantees about compatibility within specific sites & applications. Please test accordingly.


## Stay informed
Expand All @@ -113,11 +120,11 @@ You can also participate in discussions on [patternfly.slack.com](https://patter
[web components][wc-org]


[pfe-home]: https://patternfly.github.io/patternfly-elements
[getting-started]: https://patternfly.github.io/patternfly-elements/getting-started
[catalog]: https://patternfly.github.io/patternfly-elements/demo
[creating]: https://patternfly.github.io/patternfly-elements/develop
[theming]: https://patternfly.github.io/patternfly-elements/theme
[pfe-home]: https://patternflyelements.org
[getting-started]: https://patternflyelements.org/get-started
[catalog]: https://patternflyelements.org/components
[creating]: https://patternflyelements.org/docs/develop/create/
[theming]: https://patternflyelements.org/theming/
[wc-org]: https://webcomponents.org

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://github.com/prettier/prettier) ![Dependabot](https://api.dependabot.com/badges/status?host=github&repo=patternfly/patternfly-elements)
12 changes: 3 additions & 9 deletions brand/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,9 @@ h1 {
}

pfe-card .img-link {
display: block;
margin-left: auto;
margin-right: auto;
}

pfe-card .img-link > img {
display: block;
margin-left: auto;
margin-right: auto;
display: flex;
align-items: center;
justify-content: center;
}

pfe-card h2 {
Expand Down
82 changes: 82 additions & 0 deletions docs/.eleventy.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
let compress = require("compression");
let markdownIt = require("markdown-it");
let markdownItAnchor = require("markdown-it-anchor");
let markdownItContainer = require("markdown-it-container");

module.exports = function (eleventyConfig) {
/**
* Collections to organize by alphabetical instead of date
*/
const tagsToAlphabetize = [
'component'
];

for (let i = 0; i < tagsToAlphabetize.length; i++) {
const tag = tagsToAlphabetize[i];

eleventyConfig.addCollection(tag, collection => {
return collection.getFilteredByTag(tag).sort((a, b) => {
if (a.data.title < b.data.title) { return -1; }
if (a.data.title > b.data.title) { return 1; }
return 0;
});
});
}

/**
* Collections to organize by order instead of date
*/
const tagsToOrderByOrder = [
"develop"
];

for (let i = 0; i < tagsToOrderByOrder.length; i++) {
const tag = tagsToOrderByOrder[i];

eleventyConfig.addCollection(tag, collection => {
return collection.getFilteredByTag(tag).sort((a, b) => a.data.order - b.data.order);
});
}

eleventyConfig.setTemplateFormats([
"html",
"md",
"css",
"js",
"svg",
"png"
]);

eleventyConfig.setBrowserSyncConfig({
server: {
baseDir: "./_site",
middleware: [compress()]
}
});

eleventyConfig.addWatchTarget("**/*.css");
eleventyConfig.addPassthroughCopy("node_modules/@patternfly/**/*");

let options = { html: true };
let markdownLib = markdownIt(options);
markdownLib.use(markdownItAnchor);
markdownLib.use(markdownItContainer, "section", {
validate: params => {
return params.trim().match(/^section+(.*)$/);
},
render: (tokens, idx) => {
let m = tokens[idx].info.trim().match(/^section+(.*)$/);
let color = m && m[1].trim() === "header" ? "" : "lightest";
let size = m && m[1].trim() === "header" ? "" : "small";
let classes = m && m[1].trim() === "header" ? `class="header"` : "";

if (tokens[idx].nesting === 1) {
return `<pfe-band size="${size}" color="${color}"${classes}><div class="band-container">`
} else {
return `</div></pfe-band>\n`;
}
}
});

eleventyConfig.setLibrary("md", markdownLib);
};
1 change: 0 additions & 1 deletion docs/.gitignore

This file was deleted.

35 changes: 0 additions & 35 deletions docs/README.md

This file was deleted.

26 changes: 26 additions & 0 deletions docs/_includes/layout-base.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
githubLink: https://github.com/patternfly/patternfly-elements
---
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="theme-color" content="#004080">
<meta name="description" content="{{ title }} - PatternFly Elements">
<title>{{ title }} - PatternFly Elements</title>
<link href="/images/logo/pfe-icon-blue.svg" rel="shortcut icon">
<link href="https://fonts.googleapis.com/css2?family=Red+Hat+Display:wght@400;500;700&family=Red+Hat+Text&family=Overpass+Mono&display=swap" rel="stylesheet">
<link rel="stylesheet" href="/elements/pfelement/dist/pfelement.min.css">
<link rel="stylesheet" href="/elements/pfe-styles/dist/pfe-base.min.css">
<link rel="stylesheet" href="/elements/pfe-styles/dist/pfe-layouts.min.css">
<link rel="stylesheet" href="/main.css">
<link rel="stylesheet" href="/prism.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
<script src="/prism.js"></script>
<script type="module" src="/elements/pfe-band/dist/pfe-band.min.js"></script>
</head>
<body unresolved>
{{ content | safe }}
</body>
</html>
Loading