Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into release-9.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
roblarsen committed Nov 8, 2023
2 parents b6a8eba + 5f06577 commit 5385abe
Show file tree
Hide file tree
Showing 18 changed files with 105 additions and 166 deletions.
38 changes: 29 additions & 9 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,6 @@ restrictions:
- Please **do not** derail or troll issues. Keep the discussion on topic and
respect the opinions of others.

- Please **do not** open issues or pull requests regarding the code in
[`.htaccess`](https://github.com/h5bp/server-configs-apache),
[`Normalize.css`](https://github.com/necolas/normalize.css) (open them in
their respective repositories).

<a name="bugs"></a>

## Bug reports
Expand Down Expand Up @@ -126,25 +121,50 @@ included in the project:
git checkout -b <topic-branch-name>
```

4. Commit your changes in logical chunks. Please adhere to these [git commit
4. Install locked dependencies:

```bash
npm ci
```

Ensure that your `node` and `npm` versions are compatible with the `engines`
specification in `package.json`.

5. Commit your changes in logical chunks. Please adhere to these [git commit
message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
or your code is unlikely be merged into the main project. Use Git's
[interactive rebase](https://help.github.com/articles/about-git-rebase/)
feature to tidy up your commits before making them public.

5. Locally merge (or rebase) the upstream development branch into your topic branch:
6. Locally merge (or rebase) the upstream development branch into your topic branch:

```bash
git pull [--rebase] upstream main
```

6. Push your topic branch up to your fork:
7. Update any applicable test cases and run tests:

```bash
npm run test
```

Tests must cover changes and pass to be accepted.

8. Run build and commit changes to dist:

```bash
npm run build
git add dist/
git commit
```

9. Push your topic branch up to your fork:

```bash
git push origin <topic-branch-name>
```

7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
10. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description.

**IMPORTANT**: By submitting a patch, you agree to allow the project
Expand Down
7 changes: 2 additions & 5 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Support

For personal support requests with HTML5 Boilerplate please use Stack Overflow
([`html5boilerplate`](https://stackoverflow.com/questions/tagged/html5boilerplate) tag).

Please check the respective repository/website for support regarding the code in
[`.htaccess`](https://github.com/h5bp/server-configs-apache),
[`Normalize.css`](https://github.com/necolas/normalize.css).
([`html5boilerplate`](https://stackoverflow.com/questions/tagged/html5boilerplate)
tag).
2 changes: 1 addition & 1 deletion .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ jobs:
asset_name: html5-boilerplate_${{ steps.get_version.outputs.VERSION }}.zip
asset_content_type: application/zip
- name: Setup Node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 18
registry-url: https://registry.npmjs.org/
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/push-to-template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
${{ runner.os }}-node-
- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 'lts/*'
- name: Install dependencies
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: streetsidesoftware/cspell-action@v3
- uses: streetsidesoftware/cspell-action@v4
with:
inline: warning
strict: false
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
${{ runner.os }}-node-
- uses: actions/checkout@v4
- name: Run tests ${{ matrix.node-version }}
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
Expand Down
File renamed without changes.
6 changes: 2 additions & 4 deletions dist/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@

<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title></title>
<link rel="stylesheet" href="css/style.css">
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">

<meta property="og:title" content="">
<meta property="og:type" content="">
Expand All @@ -16,9 +17,6 @@
<link rel="icon" href="/icon.svg" type="image/svg+xml">
<link rel="apple-touch-icon" href="icon.png">

<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/style.css">

<link rel="manifest" href="site.webmanifest">
<meta name="theme-color" content="#fafafa">
</head>
Expand Down
26 changes: 2 additions & 24 deletions docs/css.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,11 @@ table of contents](TOC.md)

HTML5 Boilerplate's CSS includes:

- [Normalize.css](#normalizecss)
- [style.css](#stylecss)

## Normalize.css

In order to make browsers render all elements more consistently and in line with
modern standards, we include Normalize.css — a modern, HTML5-ready alternative
to CSS resets.

As opposed to CSS resets, Normalize.css:

- targets only the styles that need normalizing
- preserves useful browser defaults rather than erasing them
- corrects bugs and common browser inconsistencies
- improves usability with subtle improvements
- doesn't clutter the debugging tools
- has better documentation

For more information about Normalize.css, please refer to its [project
page](https://necolas.github.io/normalize.css/).

## style.css

Several base styles are included that build upon `Normalize.css`. These styles:
Several base styles are included. These styles:

- provide basic typography settings that improve text readability
- protect against unwanted `text-shadow` during text highlighting
Expand All @@ -38,7 +19,4 @@ Several base styles are included that build upon `Normalize.css`. These styles:
- and more...

These styles are included in
[style.css](https://github.com/h5bp/html5-boilerplate/blob/main/dist/css/style.css)
using [main.css](https://github.com/h5bp/main.css) project.
See the main.css [documentation](https://github.com/h5bp/main.css/blob/main/README.md#features)
for a full discussion of these styles.
[style.css](https://github.com/h5bp/html5-boilerplate/blob/main/dist/css/style.css).
15 changes: 6 additions & 9 deletions docs/extend.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,14 +130,14 @@ plugin](https://developer.mozilla.org/en-US/docs/Web/OpenSearch).

## Miscellaneous

- Use [Microformats](http://microformats.org/wiki/Main_Page) (via
[microdata](http://microformats.org/wiki/microdata)) for optimum search
- Use [Microformats](https://microformats.org/wiki/Main_Page) (via
[microdata](https://microformats.org/wiki/microdata)) for optimum search
results
[visibility](https://webmasters.googleblog.com/2009/05/introducing-rich-snippets.html).
[visibility](https://developers.google.com/search/blog/2009/05/introducing-rich-snippets).

- If you want to disable the translation prompt in Chrome or block Google
Translate from translating your web page, use [`<meta name="google"
content="notranslate">`](https://support.google.com/webmasters/answer/79812).
content="notranslate">`](https://developers.google.com/search/docs/crawling-indexing/special-tags).
To disable translation for a particular section of the web page, add
[`class="notranslate"`](https://support.google.com/translate/?hl=en#2641276).

Expand Down Expand Up @@ -222,10 +222,7 @@ Twitter provides a snippet specification that serves a similar purpose to Open
Graph. In fact, Twitter will use Open Graph when Cards is not available. You can
read more about the various snippet formats in the
[official Twitter Cards
documentation](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/abouts-cards),
and you can validate your markup with the [Card
validator](https://cards-dev.twitter.com/validator) (needs registration to
Twitter).
documentation](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards).

```html
<meta name="twitter:card" content="summary">
Expand All @@ -248,7 +245,7 @@ search-engine, although this vocabulary is also used by Microsoft, Pinterest and
Yandex.

You can validate your markup with the [Structured Data Testing
Tool](https://search.google.com/structured-data/testing-tool). Also, please
Tool](https://developers.google.com/search/docs/appearance/structured-data). Also, please
note that this markup requires to add attributes to your top `html` tag.

```html
Expand Down
2 changes: 1 addition & 1 deletion docs/html.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ details.

### Open Graph Metadata

The [Open Graph Protocol](https://ogp.me/) allows you to define the way your
The [Open Graph Protocol](https://ogp.me) allows you to define the way your
site is presented when referenced on third party sites and applications
(Facebook, Twitter, LinkedIn). The protocol provides a series of meta elements
that define the details of your site. The required attributes define the title,
Expand Down
1 change: 0 additions & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ A basic HTML5 Boilerplate site initially looks something like this:
```
.
├── css
│ ├── normalize.css
│ └── style.css
├── doc
├── img
Expand Down
Loading

0 comments on commit 5385abe

Please sign in to comment.