[ { "path": ".cspell.json", "content": "{\n \"version\": \"0.2\",\n \"words\": [\n \"codeql\",\n \"devdeps\",\n \"FOUC\",\n \"lighttpd\",\n \"mkdir\",\n \"modernizr\",\n \"robotstxt\",\n \"vuejs\",\n \"cpina\"\n ],\n \"language\": \"en,en-GB,en-US\",\n \"allowCompoundWords\": true,\n \"files\": [\"**/*.md\"],\n \"ignoreRegExpList\": [\"\\\\_\\\\w+\", \"\\\\#\\\\w+\"],\n \"ignorePaths\": [\".cspell.json\"],\n \"useGitignore\": true\n}\n" }, { "path": ".editorconfig", "content": "# For more information about the properties used in\n# this file, please see the EditorConfig documentation:\n# https://editorconfig.org/\n\nroot = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\nindent_size = 2\nindent_style = space\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n\n[*.md]\ntrim_trailing_whitespace = false\n" }, { "path": ".gitattributes", "content": "# Automatically normalize line endings for all text-based files\n# https://git-scm.com/docs/gitattributes#_end_of_line_conversion\n\n* text=auto\n\n# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n\n# For the following file types, normalize line endings to LF on\n# checkin and prevent conversion to CRLF when they are checked out\n# (this is required in order to prevent newline related issues like,\n# for example, after the build script is run)\n\n.* text eol=lf\n*.css text eol=lf\n*.html text eol=lf\n*.js text eol=lf\n*.json text eol=lf\n*.md text eol=lf\n*.mjs text eol=lf\n*.sh text eol=lf\n*.txt text eol=lf\n*.xml text eol=lf\n*.yml text eol=lf\n" }, { "path": ".github/CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n- Using welcoming and inclusive language\n- Being respectful of differing viewpoints and experiences\n- Gracefully accepting constructive criticism\n- Focusing on what is best for the community\n- Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n- The use of sexualized language or imagery and unwelcome sexual attention or advances\n- Trolling, insulting/derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or electronic address, without explicit permission\n- Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at h5bp@htmlcssjavascript.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]\n\n[homepage]: https://contributor-covenant.org\n[version]: https://contributor-covenant.org/version/1/4/\n" }, { "path": ".github/CONTRIBUTING.md", "content": "# Contributing to HTML5 Boilerplate\n\n♥ [HTML5 Boilerplate](https://html5boilerplate.com/) and want to get involved?\nThanks! We're actively looking for folks interested in helping out and there\nare plenty of ways you can help!\n\nPlease take a moment to review this document in order to make the contribution\nprocess easy and effective for everyone involved.\n\nFollowing these guidelines helps to communicate that you respect the time of\nthe developers managing and developing this open source project. In return,\nthey should reciprocate that respect in addressing your issue or assessing\npatches and features.\n\n## Using the issue tracker\n\nThe [issue tracker](https://github.com/h5bp/html5-boilerplate/issues) is\nthe preferred channel for [bug reports](#bugs), [features requests](#features)\nand [submitting pull requests](#pull-requests), but please respect the following\nrestrictions:\n\n- Please **do not** use the issue tracker for personal support requests (use\n [Stack Overflow](https://stackoverflow.com/questions/tagged/html5boilerplate)).\n\n- Please **do not** derail or troll issues. Keep the discussion on topic and\n respect the opinions of others.\n\n\n\n## Bug reports\n\nA bug is a _demonstrable problem_ that is caused by the code in the repository.\nGood bug reports are extremely helpful - thank you!\n\nGuidelines for bug reports:\n\n1. **Use the GitHub issue search** — check if the issue has already been\n reported.\n\n2. **Check if the issue has been fixed** — try to reproduce it using the\n latest `main` or development branch in the repository.\n\n3. **Isolate the problem** — ideally create a [reduced test\n case](https://css-tricks.com/reduced-test-cases/) and a live example.\n\nA good bug report shouldn't leave others needing to chase you up for more\ninformation. Please try to be as detailed as possible in your report. What is\nyour environment? What steps will reproduce the issue? What browser(s) and OS\nexperience the problem? What would you expect to be the outcome? All these\ndetails will help people to fix any potential bugs.\n\nExample:\n\n> Short and descriptive example bug report title\n>\n> A summary of the issue and the browser/OS environment in which it occurs. If\n> suitable, include the steps required to reproduce the bug.\n>\n> 1. This is the first step\n> 2. This is the second step\n> 3. Further steps, etc.\n>\n> `` - a link to the reduced test case\n>\n> Any other information you want to share that is relevant to the issue being\n> reported. This might include the lines of code that you have identified as\n> causing the bug, and potential solutions (and your opinions on their\n> merits).\n\n\n\n## Feature requests\n\nFeature requests are welcome. But take a moment to find out whether your idea\nfits with the scope and aims of the project. It's up to _you_ to make a strong\ncase to convince the project's developers of the merits of this feature. Please\nprovide as much detail and context as possible.\n\n\n\n## Pull requests\n\nGood pull requests - patches, improvements, new features - are a fantastic\nhelp. They should remain focused in scope and avoid containing unrelated\ncommits.\n\n**Please ask first** before embarking on any significant pull request (e.g.\nimplementing features, refactoring code, porting to a different language),\notherwise you risk spending a lot of time working on something that the\nproject's developers might not want to merge into the project.\n\nPlease adhere to the coding conventions used throughout a project (indentation,\naccurate comments, etc.) and any other requirements (such as test coverage).\n\nAdhering to the following process is the best way to get your work\nincluded in the project:\n\n1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your\n fork, and configure the remotes:\n\n ```bash\n # Clone your fork of the repo into the current directory\n git clone https://github.com//html5-boilerplate.git\n # Navigate to the newly cloned directory\n cd html5-boilerplate\n # Assign the original repo to a remote called \"upstream\"\n git remote add upstream https://github.com/h5bp/html5-boilerplate.git\n ```\n\n2. If you cloned a while ago, get the latest changes from upstream:\n\n ```bash\n git checkout main\n git pull upstream main\n ```\n\n3. Create a new topic branch (off the main project development branch) to\n contain your feature, change, or fix:\n\n ```bash\n git checkout -b \n ```\n\n4. Install locked dependencies:\n\n ```bash\n npm ci\n ```\n\n Ensure that your `node` and `npm` versions are compatible with the `engines`\n specification in `package.json`.\n\n5. Commit your changes in logical chunks. Please adhere to these [git commit\n message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)\n or your code is unlikely be merged into the main project. Use Git's\n [interactive rebase](https://help.github.com/articles/about-git-rebase/)\n feature to tidy up your commits before making them public.\n\n6. Locally merge (or rebase) the upstream development branch into your topic branch:\n\n ```bash\n git pull [--rebase] upstream main\n ```\n\n7. Update any applicable test cases and run tests:\n\n ```bash\n npm run test\n ```\n\n Tests must cover changes and pass to be accepted.\n\n8. Run build and commit changes to dist:\n\n ```bash\n npm run build\n git add dist/\n git commit\n ```\n\n9. Push your topic branch up to your fork:\n\n ```bash\n git push origin \n ```\n\n10. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)\n with a clear title and description.\n\n**IMPORTANT**: By submitting a patch, you agree to allow the project\nowners to license your work under the terms of the [MIT License](LICENSE.txt).\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.yml", "content": "name: Report a bug\ndescription: Tell us about a bug or issue you may have identified in HTML5 Boilerplate.\ntitle: \"Provide a general summary of the issue\"\nlabels: [bug]\nassignees: \"-\"\nbody:\n - type: checkboxes\n attributes:\n label: Prerequisites\n description: Take a couple minutes to help our maintainers work faster.\n options:\n - label: I have [searched](https://github.com/h5bp/html5-boilerplate/issues?utf8=%E2%9C%93&q=is%3Aissue) for duplicate or closed issues\n required: true\n - label: I have read the [contributing guidelines](https://github.com/h5bp/html5-boilerplate/blob/main/.github/CONTRIBUTING.md)\n required: true\n - type: textarea\n id: what-happened\n attributes:\n label: Describe the issue\n description: Provide a summary of the issue and what you expected to happen, including specific steps to reproduce.\n validations:\n required: true\n - type: textarea\n id: reduced-test-case\n attributes:\n label: Reduced test cases\n description: Include links [reduced test case](https://css-tricks.com/reduced-test-cases/) links.\n validations:\n required: false\n - type: dropdown\n id: os\n attributes:\n label: What operating system(s) are you seeing the problem on?\n multiple: true\n options:\n - Windows\n - macOS\n - Android\n - iOS\n - Linux\n validations:\n required: true\n - type: dropdown\n id: browser\n attributes:\n label: What browser(s) are you seeing the problem on?\n multiple: true\n options:\n - Chrome\n - Safari\n - Firefox\n - Microsoft Edge\n - Opera\n - Development Environment\n - type: input\n id: version\n attributes:\n label: What version of HTML% Boilerplate are you using?\n placeholder: \"e.g., v8.0.0 or v7.1.0\"\n validations:\n required: true\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false\ncontact_links:\n - name: Ask the community\n url: https://github.com/h5bp/html5-boilerplate/discussions/new\n about: Ask and discuss questions with other HTML5 Boilerplate community members.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.yml", "content": "name: Feature request\ndescription: Suggest new or updated features to include in HTML5 Boilerplate.\ntitle: \"Suggest a new feature\"\nlabels: [feature]\nassignees: []\nbody:\n - type: checkboxes\n attributes:\n label: Prerequisites\n description: Take a couple minutes to help our maintainers work faster.\n options:\n - label: I have [searched](https://github.com/h5bp/html5-boilerplate/issues?utf8=%E2%9C%93&q=is%3Aissue) for duplicate or closed issues\n required: true\n - label: I have read the [contributing guidelines](https://github.com/h5bp/html5-boilerplate/blob/main/.github/CONTRIBUTING.md)\n required: true\n - type: textarea\n id: proposal\n attributes:\n label: Proposal\n description: Provide detailed information for what we should add, including relevant links to prior art, screenshots, or live demos whenever possible.\n validations:\n required: true\n - type: textarea\n id: motivation\n attributes:\n label: Motivation and context\n description: Tell us why this change is needed or helpful, and what problems it may help solve.\n validations:\n required: true\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "## Types of changes\n\n\n\n- [ ] Bug fix (non-breaking change which fixes an issue)\n- [ ] New feature (non-breaking change which adds functionality)\n- [ ] Breaking change (fix or feature that would cause existing functionality to change)\n\n## Checklist:\n\n\n\n\n- [ ] My code follows the code style of this project.\n- [ ] My change requires a change to the documentation.\n- [ ] I have updated the documentation accordingly.\n- [ ] I have read the **[CONTRIBUTING](https://github.com/h5bp/html5-boilerplate/blob/main/.github/CONTRIBUTING.md)** document.\n- [ ] I have added tests to cover my changes.\n- [ ] All new and existing tests passed.\n\nPull requests should be thought of as a conversation. There will be some back and forth when trying to get code merged into this or any other project. With all but the simplest changes you can and should expect that the maintainers of the project will request changes to your code. Please be aware of that and check in after you open your PR in order to get your code merged in cleanly.\n\nThanks!\n" }, { "path": ".github/SUPPORT.md", "content": "# Support\n\nFor personal support requests with HTML5 Boilerplate please use Stack Overflow\n([`html5boilerplate`](https://stackoverflow.com/questions/tagged/html5boilerplate)\ntag).\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n - package-ecosystem: npm\n directory: \"/\"\n schedule:\n interval: monthly\n versioning-strategy: increase\n - package-ecosystem: npm\n directory: \"/src/\"\n schedule:\n interval: monthly\n versioning-strategy: increase\n - package-ecosystem: github-actions\n directory: \"/\"\n schedule:\n interval: monthly\n" }, { "path": ".github/workflows/build-dist.yml", "content": "name: Build and PR dist changes\n\non:\n push:\n branches: [main]\n\njobs:\n build-and-pr-dist:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0\n with:\n persist-credentials: false\n\n - name: Setup Node.js\n uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0\n with:\n node-version: \"lts/*\"\n\n - name: Install dependencies\n run: npm ci\n\n - name: Build project\n run: npm run build\n\n - name: Check for dist changes\n id: git-diff\n run: |\n git config --global user.name \"github-actions[bot]\"\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git add dist\n if git diff --cached --quiet; then\n echo \"changed=false\" >> $GITHUB_OUTPUT\n else\n echo \"changed=true\" >> $GITHUB_OUTPUT\n fi\n\n - name: Create Pull Request for dist changes\n if: steps.git-diff.outputs.changed == 'true'\n uses: peter-evans/create-pull-request@v6\n with:\n commit-message: \"chore(dist): update dist folder after build\"\n title: \"chore(dist): update dist folder after build\"\n body: \"This PR updates the dist folder with the latest build output.\"\n branch: update-dist-after-build\n add-paths: dist\n" }, { "path": ".github/workflows/codeql-analysis.yml", "content": "name: \"CodeQL\"\n\non:\n push:\n branches:\n - main\n - \"!dependabot/**\"\n pull_request:\n branches:\n - main\n - \"!dependabot/**\"\n workflow_dispatch:\n\njobs:\n analyze:\n name: Analyze\n runs-on: ubuntu-latest\n permissions:\n actions: read\n contents: read\n security-events: write\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0\n with:\n persist-credentials: false\n\n - name: Initialize CodeQL\n uses: github/codeql-action/init@3599b3baa15b485a2e49ef411a7a4bb2452e7f93 # v3.30.5\n with:\n languages: \"javascript\"\n queries: +security-and-quality\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@3599b3baa15b485a2e49ef411a7a4bb2452e7f93 # v3.30.5\n" }, { "path": ".github/workflows/dependency-review.yml", "content": "name: \"Dependency Review\"\non: [pull_request]\n\npermissions:\n contents: read\n\njobs:\n dependency-review:\n runs-on: ubuntu-latest\n steps:\n - name: \"Checkout Repository\"\n uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0\n with:\n persist-credentials: false\n\n - name: \"Dependency Review\"\n uses: actions/dependency-review-action@595b5aeba73380359d98a5e087f648dbb0edce1b # v4.7.3\n" }, { "path": ".github/workflows/ossf-scorecard.yml", "content": "name: Scorecard supply-chain security\non:\n branch_protection_rule:\n schedule:\n - cron: '27 12 * * 2'\n push:\n branches: [ \"main\" ]\n\npermissions: read-all\n\njobs:\n analysis:\n name: Scorecard analysis\n runs-on: ubuntu-latest\n if: github.event.repository.default_branch == github.ref_name || github.event_name == 'pull_request'\n permissions:\n security-events: write\n id-token: write\n\n steps:\n - name: \"Checkout code\"\n uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0\n with:\n persist-credentials: false\n\n - name: \"Run analysis\"\n uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3\n with:\n results_file: results.sarif\n results_format: sarif\n publish_results: true\n\n - name: \"Upload artifact\"\n uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2\n with:\n name: SARIF file\n path: results.sarif\n retention-days: 5\n\n - name: \"Upload to code-scanning\"\n uses: github/codeql-action/upload-sarif@3599b3baa15b485a2e49ef411a7a4bb2452e7f93 # v3.30.5\n with:\n sarif_file: results.sarif\n" }, { "path": ".github/workflows/publish.yml", "content": "name: Publish\n\non:\n push:\n tags:\n - \"v*\"\n\npermissions:\n contents: read\n\njobs:\n build:\n permissions:\n contents: write # for actions/create-release to create a release\n name: Upload Release Asset\n runs-on: ubuntu-latest\n steps:\n - name: Checkout code\n uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0\n with:\n persist-credentials: false\n - name: Get tag\n id: get_version\n run: echo VERSION=$(echo $GITHUB_REF | cut -d / -f 3) >> \"$GITHUB_OUTPUT\"\n - name: Create Zip Folder\n working-directory: dist\n run: zip -r ../html5-boilerplate_${{ steps.get_version.outputs.VERSION }}.zip ./\n - name: Create Release\n id: create_release\n uses: actions/create-release@0cb9c9b65d5d1901c1f53e5e66eaf4afd303e70e # v1.1.4\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n tag_name: ${{ github.ref }}\n release_name: Release ${{ github.ref }}\n draft: false\n prerelease: false\n - name: Upload Release Asset\n id: upload-release-asset\n uses: actions/upload-release-asset@e8f9f06c4b078e705bd2ea027f0926603fc9b4d5 # v1.0.2\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n upload_url: ${{ steps.create_release.outputs.upload_url }}\n asset_path: ./html5-boilerplate_${{ steps.get_version.outputs.VERSION }}.zip\n asset_name: html5-boilerplate_${{ steps.get_version.outputs.VERSION }}.zip\n asset_content_type: application/zip\n - name: Setup Node\n uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0\n with:\n node-version: 20\n registry-url: https://registry.npmjs.org/\n - name: publish npm\n run: npm publish\n env:\n NODE_AUTH_TOKEN: ${{secrets.npm_token}}\n" }, { "path": ".github/workflows/push-to-template.yml", "content": "name: Push to template repository\n\non:\n push:\n branches: [main]\n\npermissions:\n contents: read\n\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n - name: Get npm cache directory\n id: npm-cache\n run: |\n echo \"dir=$(npm config get cache)\" >> \"$GITHUB_OUTPUT\"\n - uses: actions/cache@v3\n with:\n path: ${{ steps.npm-cache.outputs.dir }}\n key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}\n restore-keys: |\n ${{ runner.os }}-node-\n - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0\n with:\n persist-credentials: false\n - name: Setup Node.js\n uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0\n with:\n node-version: \"lts/*\"\n - name: Install dependencies\n run: npm ci\n - name: Build\n run: npm run build\n - name: Pushes to another repository\n uses: cpina/github-action-push-to-another-repository@main\n env:\n API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}\n with:\n source-directory: \"dist\"\n destination-github-username: \"h5bp\"\n destination-repository-name: \"html5-boilerplate-template\"\n user-name: \"roblarsen\"\n user-email: rob@htmlcssjavascript.com\n commit-message: \"The latest and greatest from HTML5 Boilerplate\"\n" }, { "path": ".github/workflows/spellcheck.yml", "content": "name: \"Check spelling\"\non: # rebuild any PRs and main branch changes\n push:\n branches-ignore:\n - \"dependabot/**\"\n pull_request:\n\npermissions:\n contents: read\n\njobs:\n spellcheck:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0\n with:\n persist-credentials: false\n\n - uses: streetsidesoftware/cspell-action@dcd03dc3e8a59ec2e360d0c62db517baa0b4bb6d # v7.2.0\n with:\n inline: warning\n strict: false\n incremental_files_only: true\n" }, { "path": ".github/workflows/test.yml", "content": "name: Build status\n\non:\n push:\n branches: [main]\n pull_request:\n branches: [main]\n workflow_dispatch:\n\npermissions:\n contents: read\n\njobs:\n build:\n runs-on: ${{ matrix.os }}\n strategy:\n matrix:\n node-version:\n - 20\n - 22\n - 24\n os: [ubuntu-latest, windows-latest]\n\n steps:\n - name: Get npm cache directory\n id: npm-cache\n run: |\n echo \"dir=$(npm config get cache)\" >> \"$GITHUB_OUTPUT\"\n - uses: actions/cache@2f8e54208210a422b2efd51efaa6bd6d7ca8920f # v3.4.3\n with:\n path: ${{ steps.npm-cache.outputs.dir }}\n key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}\n restore-keys: |\n ${{ runner.os }}-node-\n - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0\n - name: Run tests ${{ matrix.node-version }}\n uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0\n with:\n node-version: ${{ matrix.node-version }}\n - run: npm ci\n - run: npm test\n" }, { "path": ".gitignore", "content": "**/.DS_Store\narchive\nnode_modules\npackages\ndist/package-lock.json\nsrc/package-lock.json\n" }, { "path": ".npmrc", "content": "lockfile-version = 3\nregistry = \"https://registry.npmjs.org/\"\n" }, { "path": ".prettierignore", "content": "dist/\n" }, { "path": ".prettierrc.json", "content": "{\n \"bracketSameLine\": true,\n \"embeddedLanguageFormatting\": \"off\",\n \"singleQuote\": true,\n \"overrides\": [\n {\n \"files\": \"**/*.yml\",\n \"options\": {\n \"singleQuote\": false\n }\n }\n ]\n}\n" }, { "path": ".vscode/extensions.json", "content": "{\n \"recommendations\": [\n \"dbaeumer.vscode-eslint\",\n \"editorconfig.editorconfig\",\n \"esbenp.prettier-vscode\",\n \"streetsidesoftware.code-spell-checker\"\n ]\n}\n" }, { "path": ".vscode/settings.json", "content": "{\n \"[javascript][typescript][json][jsonc][markdown][yaml]\": {\n \"editor.defaultFormatter\": \"esbenp.prettier-vscode\",\n \"editor.formatOnSave\": true\n },\n \"[javascript][typescript]\": {\n \"editor.codeActionsOnSave\": {\n \"source.fixAll.eslint\": \"explicit\"\n }\n },\n \"eslint.validate\": [\"javascript\", \"typescript\"],\n \"editor.formatOnSave\": true,\n \"editor.renderWhitespace\": \"all\",\n \"files.trimTrailingWhitespace\": true\n}\n" }, { "path": "CHANGELOG.md", "content": "# Changelog\n\n## 9.0.1 (April 11, 2024)\n\n- Fixed tests on Windows, adds Windows Testing Action [#3110](https://github.com/h5bp/html5-boilerplate/pull/3110)\n- Add og:image:alt for accessibility [#3066](https://github.com/h5bp/html5-boilerplate/pull/3066)\n- Upgrade to Gulp 5 [#3100](https://github.com/h5bp/html5-boilerplate/pull/3100) [#3105](https://github.com/h5bp/html5-boilerplate/pull/3105)\n- ci: Use GITHUB_OUTPUT envvar instead of set-output command [#3068](https://github.com/h5bp/html5-boilerplate/pull/3068)\n- Readme and Changelog updates [#3055](https://github.com/h5bp/html5-boilerplate/pull/3055) [#3057](https://github.com/h5bp/html5-boilerplate/pull/3057) [#3064](https://github.com/h5bp/html5-boilerplate/pull/3064)\n\n## 9.0.0 (December 6, 2023)\n\n- Removing tile images [#3023](https://github.com/h5bp/html5-boilerplate/pull/3023)\n- Add Prettier [#3011](https://github.com/h5bp/html5-boilerplate/pull/3011)\n- Remove Modernizr [#3002](https://github.com/h5bp/html5-boilerplate/issues/3002)\n- Drop Normalize.css [#2960](https://github.com/h5bp/html5-boilerplate/pull/2960)\n- Create WebPack build to ship with the project [#2650](https://github.com/h5bp/html5-boilerplate/issues/2650)\n- Sets package to private by default [#2888](https://github.com/h5bp/html5-boilerplate/pull/2888)\n- Removes Babel and upgrades our gulpfile to use ES Modules [#2831](https://github.com/h5bp/html5-boilerplate/pull/2831)\n- Farewell Internet Explorer! [#2773](https://github.com/h5bp/html5-boilerplate/issues/2773)\n- Remove apache-server-configs/.htaccess [#2779](https://github.com/h5bp/html5-boilerplate/pull/2779)\n- Moving docs out of src and dist [#2655](https://github.com/h5bp/html5-boilerplate/pull/2655)\n- Replace Parcel with Webpack [#2641](https://github.com/h5bp/html5-boilerplate/pull/2641)\n- Add SVG Favicon [#2554](https://github.com/h5bp/html5-boilerplate/issues/2554)\n- Remove Google Analytics [#2547](https://github.com/h5bp/html5-boilerplate/issues/2547)\n- Rename master branch to main [#2583](https://github.com/h5bp/html5-boilerplate/issues/2583)\n- Remove humans.txt [#2584](https://github.com/h5bp/html5-boilerplate/pull/2584)\n- Add a template repository [#2391](https://github.com/h5bp/html5-boilerplate/pull/2391)\n- Remove plugins js [#2346](https://github.com/h5bp/html5-boilerplate/pull/2346)\n- Rename CSS file [#2342](https://github.com/h5bp/html5-boilerplate/pull/2342) and JS file [#2341](https://github.com/h5bp/html5-boilerplate/pull/2341)\n\n## 8.0.0 (June 04, 2020)\n\n- Add a sample package.json with basic Parcel commands ([#2227](https://github.com/h5bp/html5-boilerplate/pull/2229)), ([231e047](https://github.com/h5bp/html5-boilerplate/commit/231e047d270316b454156dc261e6e04da660e2a2))\n- Add sample Open Graph metadata ([#2235](https://github.com/h5bp/html5-boilerplate/pull/2235))\n- Update Modernizr to 3.11.2 ([84ae9cc](https://github.com/h5bp/html5-boilerplate/commit/84ae9cc91188bea4edb8ec91e2a25a2a7f7837a6))\n- Remove jQuery ([#2225](https://github.com/h5bp/html5-boilerplate/pull/2225))\n- Set anonymizeIp to true in Google Analytics snippet ([#2219](https://github.com/h5bp/html5-boilerplate/pull/2219))\n- Update main.css to 2.1.0 ([#2234](https://github.com/h5bp/html5-boilerplate/pull/2234))\n- Remove Browser Upgrade Prompt ([23c4112](https://github.com/h5bp/html5-boilerplate/commit/23c4112db067262c715ebad861ec892c29c3cdaa))\n- Create new publish action ([#2260](https://github.com/h5bp/html5-boilerplate/pull/2260)), ([#2241](https://github.com/h5bp/html5-boilerplate/pull/2241))\n- Docs updates ([#2251](https://github.com/h5bp/html5-boilerplate/pull/2251)), ([#2253](https://github.com/h5bp/html5-boilerplate/pull/2253)), ([#2245](https://github.com/h5bp/html5-boilerplate/pull/2245)), ([#2220](https://github.com/h5bp/html5-boilerplate/pull/2220)), ([#2263](https://github.com/h5bp/html5-boilerplate/pull/2263)), ([#2262](https://github.com/h5bp/html5-boilerplate/pull/2262))\n\n## 7.3.0 (November 19, 2019)\n\n- Update Modernizr to 3.8 ([2b2bb45](https://github.com/h5bp/html5-boilerplate/commit/2b2bb453916b4b09a6f0929340290dc2505f7ce9))\n- Update to Gulp 4 ([#2151](https://github.com/h5bp/html5-boilerplate/pull/2151))\n- Update package.json ([#2162](https://github.com/h5bp/html5-boilerplate/pull/#2162)) and enable package-lock.json ([abe2087](https://github.com/h5bp/html5-boilerplate/commit/abe20877fdb569c84aa0a1f8ae12c51c51e41250)),([#2145](https://github.com/h5bp/html5-boilerplate/pull/#2145))\n- Remove redundant rules from .editorconfig ([#2157](https://github.com/h5bp/html5-boilerplate/pull/2157))\n- Small docs maintenance updates ([#2155](https://github.com/h5bp/html5-boilerplate/pull/2155)), ([#2164](https://github.com/h5bp/html5-boilerplate/pull/2164)), ([#2165](https://github.com/h5bp/html5-boilerplate/pull/2165)), ([#2167](https://github.com/h5bp/html5-boilerplate/pull/2167)) & ([#2168](https://github.com/h5bp/html5-boilerplate/pull/2168))\n- Bump lowest supported version of node to 8.x ([#2142](https://github.com/h5bp/html5-boilerplate/pull/2142))\n- Remove .jscsrc config and remove gulp-jscs from package.json ([#2153](https://github.com/h5bp/html5-boilerplate/pull/2153))\n\n## 7.2.0 (June 4, 2019)\n\n- Remove `defer` from Google Analytics snippet ([#2132](https://github.com/h5bp/html5-boilerplate/pull/2132))\n- Update jQuery to v3.4.1 ([#2126](https://github.com/h5bp/html5-boilerplate/pull/2126))\n- Update Apache Server Configs to 3.2.1 ([#2128](https://github.com/h5bp/html5-boilerplate/pull/2128))\n- Update main.css to v2.0.0 ([#2135](https://github.com/h5bp/html5-boilerplate/pull/2135))\n- Docs updates ([#2122](https://github.com/h5bp/html5-boilerplate/pull/2122)), ([#2125](https://github.com/h5bp/html5-boilerplate/pull/2125)), ([#2134](https://github.com/h5bp/html5-boilerplate/pull/2134)), ([#2137](https://github.com/h5bp/html5-boilerplate/pull/2137)), ([#2138](https://github.com/h5bp/html5-boilerplate/pull/2138))\n\n## 7.1.0 (March 18, 2019)\n\n- Update Modernizr to 3.7.1 ([#2121](https://github.com/h5bp/html5-boilerplate/pull/2121))\n- Update Analytics docs and snippet ([#2118](https://github.com/h5bp/html5-boilerplate/pull/2118))\n- Minor docs updates ([#2115](https://github.com/h5bp/html5-boilerplate/pull/2115))\n- Minor devdeps updates ([#2114](https://github.com/h5bp/html5-boilerplate/pull/2114))\n- More succinct way of writing the IE conditional statement ([#2113](https://github.com/h5bp/html5-boilerplate/pull/2113))\n\n## 7.0.1 (February 11, 2019)\n\n- Bumps main.css to current version ([#2112](https://github.com/h5bp/html5-boilerplate/pull/2112))\n\n## 7.0.0 (February 8, 2019)\n\n- Drop support for IE9/IE10 (usage of these versions is tiny and Microsoft officially ended support back in 2016). ([#2074](https://github.com/h5bp/html5-boilerplate/pull/2074))\n- Move the CSS to a separate repo ([#2066](https://github.com/h5bp/html5-boilerplate/pull/2066))\n- Add theme-color meta tag to index.html ([#2074](https://github.com/h5bp/html5-boilerplate/pull/2074))\n- Add 'install with yarn' steps to README ([#2063](https://github.com/h5bp/html5-boilerplate/pull/2063))\n- Improved Webmanifest ([#2060](https://github.com/h5bp/html5-boilerplate/pull/2060))\n- Upgrade Normalize to 8.0.1 ([#2104](https://github.com/h5bp/html5-boilerplate/pull/2104))\n- Update .htaccess ([#2110](https://github.com/h5bp/html5-boilerplate/pull/2110))\n- Remove instances of `shrink-to-fit=no` ([#2103](https://github.com/h5bp/html5-boilerplate/pull/2103))\n- Removes \"display\": \"standalone\" from manifest ([#2096](https://github.com/h5bp/html5-boilerplate/pull/2096))\n- Big Docs update - Fixed links, removed IE9/IE10 specific info, made touch icons section more concise, add details on security.txt and more tidying up ([#2074](https://github.com/h5bp/html5-boilerplate/pull/2031), [#2065](https://github.com/h5bp/html5-boilerplate/pull/2065), [#2062](https://github.com/h5bp/html5-boilerplate/pull/2062))\n\n## 6.1.0 (May 1, 2018)\n\n- [Update Apache Server Configs to `v3.0.0`.](https://github.com/h5bp/html5-boilerplate/pull/2042)\n- Migrate to eslint ([#2037](https://github.com/h5bp/html5-boilerplate/pull/2037))\n- Update to jQuery 3.3.1 ([#2018](https://github.com/h5bp/html5-boilerplate/pull/2018))\n- Update to Modernizr v3.6 and Normalize v8 ([#2028](https://github.com/h5bp/html5-boilerplate/pull/2028))\n- Update Dev Dependencies ([#2032](https://github.com/h5bp/html5-boilerplate/pull/2032)) ([#2017](https://github.com/h5bp/html5-boilerplate/pull/2017)) ([#2010](https://github.com/h5bp/html5-boilerplate/pull/2010)) ([#2009](https://github.com/h5bp/html5-boilerplate/pull/2009))\n- Replace 'node-sri' with 'ssri' ([#2031](https://github.com/h5bp/html5-boilerplate/pull/2031))\n- Add .babelrc and .prettierrc to .gitattributes ([#2030](https://github.com/h5bp/html5-boilerplate/pull/2030))\n- Update .htaccess ([#2003](https://github.com/h5bp/html5-boilerplate/pull/2003))\n- Fixed JSHint errors ([#1994](https://github.com/h5bp/html5-boilerplate/pull/1994))\n- Add CODE_OF_CONDUCT.md ([#2011](https://github.com/h5bp/html5-boilerplate/pull/2011))\n- Update Documentation ([#2029](https://github.com/h5bp/html5-boilerplate/pull/2029)) ([#2015](https://github.com/h5bp/html5-boilerplate/pull/2015)) ([#2007](https://github.com/h5bp/html5-boilerplate/pull/2007)) ([#2006](https://github.com/h5bp/html5-boilerplate/pull/2006)) ([#1996](https://github.com/h5bp/html5-boilerplate/pull/1996))\n\n## 6.0.1 (August 20, 2017)\n\n- Reverts .visuallyhidden (see [#1985](https://github.com/h5bp/html5-boilerplate/issues/1985))\n\n## 6.0.0 (August 17, 2017)\n\n- Fix Bug: .visuallyhidden on macOS VO fixes #1985 ([#1989](https://github.com/h5bp/html5-boilerplate/pull/1989))\n- Adds web app manifest file ([#1963](https://github.com/h5bp/html5-boilerplate/pull/1963))\n- Update to jQuery 3.2.1 ([#1942](https://github.com/h5bp/html5-boilerplate/pull/1942))\n- Improve ::selection documentation which became confusing after c7057be ([#1955](https://github.com/h5bp/html5-boilerplate/pull/1955))\n- refactor(html): update browsehappy to https instead of http ([#1952](https://github.com/h5bp/html5-boilerplate/pull/1952))\n- Fix links to CONTRIBUTING.md ([#1951](https://github.com/h5bp/html5-boilerplate/pull/1951))\n- Adds .github folder and contents Fixes ([#1948](https://github.com/h5bp/html5-boilerplate/pull/1948))\n- Modernizr 3, modernizr.config and ([#1940](https://github.com/h5bp/html5-boilerplate/pull/1940))\n- Housekeeping by @coliff (#1968 #1969 #1965 #1964 #1958 #1957 #1956)\n- Update .gitattributes for Web Projects ([#1935](https://github.com/h5bp/html5-boilerplate/pull/1935))\n- Add the link for useful .gitignore templates ([#1936](https://github.com/h5bp/html5-boilerplate/pull/1936))\n- Node plumbing updated ([#1925](https://github.com/h5bp/html5-boilerplate/pull/1925)) ([#1928](https://github.com/h5bp/html5-boilerplate/pull/1928)) ([#1931](https://github.com/h5bp/html5-boilerplate/pull/1931))\n- Use es2015 syntax in mocha tests ([#1788](https://github.com/h5bp/html5-boilerplate/pull/1788))\n- Scope :first-letter selector for print styles ([#1904](https://github.com/h5bp/html5-boilerplate/pull/1904))\n- Add SRI Hash for jQuery ([#1904](https://github.com/h5bp/html5-boilerplate/pull/1904))\n- Update .jshintrc ([#1903](https://github.com/h5bp/html5-boilerplate/pull/1903))\n- Improve accessibility with visuallyhidden content ([#1900](https://github.com/h5bp/html5-boilerplate/pull/1900))\n- Tell users that IE 8 and 9 are outdated\n ([#1747](https://github.com/h5bp/html5-boilerplate/issues/1747)).\n- Removed IE8 Support (upgrades jQuery and normalize.css to latest)\n ([#1524](https://github.com/h5bp/html5-boilerplate/issues/1524)).\n- Fix print styles for Internet Explorer 11\n ([#1799](https://github.com/h5bp/html5-boilerplate/issues/1799)).\n- Update doc links to https\n ([#1889](https://github.com/h5bp/html5-boilerplate/issues/1889)).\n- Delete crossdomain.xml\n ([#1881](https://github.com/h5bp/html5-boilerplate/issues/1881)).\n- Adds pre-wrap to PRE\n ([#1742](https://github.com/h5bp/html5-boilerplate/issues/1742)).\n- Change license format to SPDX format\n ([#1814](https://github.com/h5bp/html5-boilerplate/pull/1814)).\n- Simplify the Google Analytics snippet using `async` & `defer` ([#1660](https://github.com/h5bp/html5-boilerplate/pull/1660#issuecomment-89285678)).\n\n## 5.3.0 (January 12, 2016)\n\n- Update jQuery to `v1.12.0`.\n- Fetch `jQuery` from jQuery's CDN instead of Google's\n ([#1737](https://github.com/h5bp/html5-boilerplate/issues/1737),\n [#1739](https://github.com/h5bp/html5-boilerplate/issues/1739)).\n- Change print color for `:first-letter` and `:first-line`\n pseudo-elements\n ([#1715](https://github.com/h5bp/html5-boilerplate/pull/1715)).\n\n## 5.2.0 (May 1, 2015)\n\n- Update jQuery to `v1.11.3`\n ([#1699](https://github.com/h5bp/html5-boilerplate/issues/1699)).\n- Deprecate protocol-relative URLs\n ([#1694](https://github.com/h5bp/html5-boilerplate/issues/1694)).\n- Update high resolution media query\n ([#1474](https://github.com/h5bp/html5-boilerplate/issues/1474)).\n- Update Apache Server Configs to `v2.14.0`.\n\n## 5.1.0 (April 1, 2015)\n\n- Update Normalize.css to `v3.0.3`.\n- Use `https://` in the Google Universal Analytics snippet\n ([eee759b](https://github.com/h5bp/html5-boilerplate/commit/eee759bfe175e850bbc8e4ad0682ec4fe4bd05d6)).\n- Remove the `visibility: hidden` declaration from `.hidden`\n ([#1663](https://github.com/h5bp/html5-boilerplate/issues/1663)).\n- Use ``
\n instead of ``\n ([#1656](https://github.com/h5bp/html5-boilerplate/issues/1656)).\n- Update Apache Server Configs to `v2.13.0`.\n\n## 5.0.0 (February 1, 2015)\n\n- Update to jQuery 1.11.2.\n- Update Apache Server Configs to v2.11.0.\n- Rename Apple touch icon to `apple-touch-icon.png` and add\n `` in `index.html`\n ([#1622](https://github.com/h5bp/html5-boilerplate/issues/1622)).\n- Add vertical centering for `iframe`\n ([#1613](https://github.com/h5bp/html5-boilerplate/issues/1613)).\n- Change the outdated browser prompt classname to `browserupgrade`\n ([#1608](https://github.com/h5bp/html5-boilerplate/issues/1608)).\n- Update to Normalize.css 3.0.2.\n ([#1050](https://github.com/h5bp/html5-boilerplate/issues/1050)).\n- Update `apple-touch-icon-precomposed.png` and the _\"Apple touch\n icons\"_ related documentation\n ([#1599](https://github.com/h5bp/html5-boilerplate/pull/1599)).\n- Add pseudo-elements to universal selector in print media query\n ([#1585](https://github.com/h5bp/html5-boilerplate/pull/1585)).\n- Update to Modernizr 2.8.3.\n- Remove need to readjust margins in `404.html`\n ([#1567](https://github.com/h5bp/html5-boilerplate/pull/1567)).\n- Add `/.editorconfig` file\n ([#1561](https://github.com/h5bp/html5-boilerplate/issues/1561),\n [#1564](https://github.com/h5bp/html5-boilerplate/issues/1564)).\n- Add `auto` to the Google Universal Analytics tracker create method\n ([#1562](https://github.com/h5bp/html5-boilerplate/issues/1562)).\n- Add `timeline` and `timelineEnd` to the list of `console` methods\n ([#1559](https://github.com/h5bp/html5-boilerplate/issues/1559)).\n- Add `lang=\"\"` to ``\n ([#1542](https://github.com/h5bp/html5-boilerplate/issues/1542)).\n- Use `` instead of ``\n ([#1522](https://github.com/h5bp/html5-boilerplate/issues/1522)).\n- Add `/browserconfig.xml` file and tile images\n ([#1481](https://github.com/h5bp/html5-boilerplate/issues/1481)).\n- Add `Disallow:` to `robots.txt`\n ([#1487](https://github.com/h5bp/html5-boilerplate/issues/1487)).\n- Remove default foreground color from form elements\n ([#1390](https://github.com/h5bp/html5-boilerplate/issues/1390)).\n- Remove default margin from print styles\n ([#1477](https://github.com/h5bp/html5-boilerplate/issues/1477)).\n- Remove image replacement helper class `.ir`\n ([#1472](https://github.com/h5bp/html5-boilerplate/issues/1472),\n [#1475](https://github.com/h5bp/html5-boilerplate/issues/1475)).\n- Add vertical centering for `svg`\n ([#1453](https://github.com/h5bp/html5-boilerplate/issues/1453)).\n- Redesign 404 page\n ([#1443](https://github.com/h5bp/html5-boilerplate/pull/1443)).\n- Remove IE 6/7 hacks from `main.css`\n ([#1050](https://github.com/h5bp/html5-boilerplate/issues/1050)).\n- Remove IE conditional classes\n ([#1187](https://github.com/h5bp/html5-boilerplate/issues/1187),\n [#1290](https://github.com/h5bp/html5-boilerplate/issues/1290)).\n\n## 4.3.0 (September 10, 2013)\n\n- Use one `apple-touch-icon` instead of six\n ([#1367](https://github.com/h5bp/html5-boilerplate/issues/1367)).\n- Move font-related declarations from `body` to `html`\n ([#1411](https://github.com/h5bp/html5-boilerplate/issues/1411)).\n- Update to Apache Server Configs 1.1.0.\n- Add `initial-scale=1` to the viewport `meta`\n ([#1398](https://github.com/h5bp/html5-boilerplate/pull/1398)).\n- Vertical centering for audio, canvas and video-tags\n ([#1326](https://github.com/h5bp/html5-boilerplate/issues/1326)).\n- Remove Google Chrome Frame related code\n ([#1379](https://github.com/h5bp/html5-boilerplate/pull/1379),\n [#1396](https://github.com/h5bp/html5-boilerplate/pull/1396)).\n- Update to Google Universal Analytics\n ([#1347](https://github.com/h5bp/html5-boilerplate/issues/1347)).\n- Update to jQuery 1.10.2.\n- Update to Normalize.css 1.1.3.\n\n## 4.2.0 (April 8, 2013)\n\n- Remove Google Analytics protocol check\n ([#1319](https://github.com/h5bp/html5-boilerplate/pull/1319)).\n- Update to Normalize.css 1.1.1.\n- Update Apache configurations to include the latest changes in the\n canonical [`.htaccess`](https://github.com/h5bp/server-configs-apache)\n file.\n- Use a protocol relative URL for the 404 template script.\n- Update to jQuery 1.9.1.\n\n## 4.1.0 (January 21, 2013)\n\n- Update to Normalize.css 1.1.0.\n- Update to jQuery 1.9.0.\n\n## 4.0.3 (January 12, 2013)\n\n- Use 32x32 favicon.ico\n ([#1286](https://github.com/h5bp/html5-boilerplate/pull/1286)).\n- Remove named function expression in plugins.js\n ([#1280](https://github.com/h5bp/html5-boilerplate/pull/1280)).\n- Adjust CSS image-replacement code\n ([#1239](https://github.com/h5bp/html5-boilerplate/issues/1239)).\n- Update HiDPI example media query\n ([#1127](https://github.com/h5bp/html5-boilerplate/issues/1127)).\n\n## 4.0.2 (December 9, 2012)\n\n- Update placeholder icons.\n- Update to Normalize.css 1.0.2.\n- Update to jQuery 1.8.3.\n\n## 4.0.1 (October 20, 2012)\n\n- Further improvements to `console` method stubbing\n ([#1206](https://github.com/h5bp/html5-boilerplate/issues/1206),\n [#1229](https://github.com/h5bp/html5-boilerplate/pull/1229)).\n- Update to jQuery 1.8.2.\n- Update to Modernizr 2.6.2.\n- Minor additions to the documentation.\n\n## 4.0.0 (August 28, 2012)\n\n- Improve the Apache compression configuration\n ([#1012](https://github.com/h5bp/html5-boilerplate/issues/1012),\n [#1173](https://github.com/h5bp/html5-boilerplate/issues/1173)).\n- Add a HiDPI example media query\n ([#1127](https://github.com/h5bp/html5-boilerplate/issues/1127)).\n- Add bundled docs\n ([#1154](https://github.com/h5bp/html5-boilerplate/issues/1154)).\n- Add MIT license\n ([#1139](https://github.com/h5bp/html5-boilerplate/issues/1139)).\n- Update to Normalize.css 1.0.1.\n- Separate Normalize.css from the rest of the CSS\n ([#1160](https://github.com/h5bp/html5-boilerplate/issues/1160)).\n- Improve `console.log` protection\n ([#1107](https://github.com/h5bp/html5-boilerplate/issues/1107)).\n- Replace hot pink text selection color with a neutral color.\n- Change image replacement technique\n ([#1149](https://github.com/h5bp/html5-boilerplate/issues/1149)).\n- Code format and consistency changes\n ([#1112](https://github.com/h5bp/html5-boilerplate/issues/1112)).\n- Rename CSS file and rename JS files and subdirectories.\n- Update to jQuery 1.8\n ([#1161](https://github.com/h5bp/html5-boilerplate/issues/1161)).\n- Update to Modernizr 2.6.1\n ([#1086](https://github.com/h5bp/html5-boilerplate/issues/1086)).\n- Remove uncompressed jQuery\n ([#1153](https://github.com/h5bp/html5-boilerplate/issues/1153)).\n- Remove superfluous inline comments\n ([#1150](https://github.com/h5bp/html5-boilerplate/issues/1150)).\n\n## 3.0.2 (February 19, 2012)\n\n- Update to Modernizr 2.5.3.\n\n## 3.0.1 (February 08, 2012)\n\n- Update to Modernizr 2.5.2 (includes html5shiv 3.3).\n\n## 3.0.0 (February 06, 2012)\n\n- Improvements to `.htaccess`.\n- Improve 404 design.\n- Simplify JS folder structure.\n- Change `html` IE class names changed to target ranges rather than\n specific versions of IE.\n- Update CSS to include latest normalize.css changes and better\n typographic defaults\n ([#825](https://github.com/h5bp/html5-boilerplate/issues/825)).\n- Update to Modernizr 2.5 (includes yepnope 1.5 and html5shiv 3.2).\n- Update to jQuery 1.7.1.\n- Revert to async snippet for the Google Analytics script.\n- Remove the ant build script\n ([#826](https://github.com/h5bp/html5-boilerplate/issues/826)).\n- Remove Respond.js\n ([#816](https://github.com/h5bp/html5-boilerplate/issues/816)).\n- Remove the `demo/` directory\n ([#808](https://github.com/h5bp/html5-boilerplate/issues/808)).\n- Remove the `test/` directory\n ([#808](https://github.com/h5bp/html5-boilerplate/issues/808)).\n- Remove Google Chrome Frame script for IE6 users; replace with links\n to Chrome Frame and options for alternative browsers.\n- Remove `initial-scale=1` from the viewport `meta`\n ([#824](https://github.com/h5bp/html5-boilerplate/issues/824)).\n- Remove `defer` from all scripts to avoid legacy IE bugs.\n- Remove explicit Site Speed tracking for Google Analytics. It's now\n enabled by default.\n\n## 2.0.0 (August 10, 2011)\n\n- Change starting CSS to be based on normalize.css instead of reset.css\n ([#500](https://github.com/h5bp/html5-boilerplate/issues/500)).\n- Add Respond.js media query polyfill.\n- Add Google Chrome Frame script prompt for IE6 users.\n- Simplify the `html` conditional comments for modern browsers and add\n an `oldie` class.\n- Update clearfix to use \"micro clearfix\".\n- Add placeholder CSS MQs for mobile-first approach.\n- Add `textarea { resize: vertical; }` to only allow vertical resizing.\n- Add `img { max-width: 100%; }` to the print styles; prevents images\n being truncated.\n- Add Site Speed tracking for Google Analytics.\n- Update to jQuery 1.6.2 (and use minified by default).\n- Update to Modernizr 2.0 Complete, Production minified (includes\n yepnope, html5shiv, and Respond.js).\n- Use `Modernizr.load()` to load the Google Analytics script.\n- Much faster build process.\n- Add build script options for CSSLint, JSLint, JSHint tools.\n- Build script now compresses all images in subfolders.\n- Build script now versions files by SHA hash.\n- Many `.htaccess` improvements including: disable directory browsing,\n improved support for all versions of Apache, more robust and extensive\n HTTP compression rules.\n- Remove `handheld.css` as it has very poor device support.\n- Remove touch-icon `link` elements from the HTML and include improved\n touch-icon support.\n- Remove the cache-busting query parameters from files references in\n the HTML.\n- Remove IE6 PNGFix.\n\n## 1.0.0 (March 21, 2011)\n\n- Rewrite build script to make it more customizable and flexible.\n- Add a humans.txt.\n- Numerous `.htaccess` improvements (including inline documentation).\n- Move the alternative server configurations to the H5BP server configs\n repo.\n- Use a protocol-relative url to reference jQuery and prevent mixed\n content warnings.\n- Optimize the Google Analytics snippet.\n- Use Eric Meyer's recent CSS reset update and the HTML5 Doctor reset.\n- More robust `sub`/`sup` CSS styles.\n- Add keyboard `.focusable` helper class that extends `.visuallyhidden`.\n- Print styles no longer print hash or JavaScript links.\n- Add a print reset for IE's proprietary filters.\n- Remove IE9-specific conditional class on the `html` element.\n- Remove margins from lists within `nav` elements.\n- Remove YUI profiling.\n" }, { "path": "LICENSE.txt", "content": "Copyright (c) HTML5 Boilerplate\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do\nso, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "# [HTML5 Boilerplate](https://html5boilerplate.com/)\n\n[![Build status](https://github.com/h5bp/html5-boilerplate/workflows/Build%20status/badge.svg)](https://github.com/h5bp/html5-boilerplate/actions?query=workflow%3A%22Build+status%22+branch%3Amain)\n[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://github.com/h5bp/html5-boilerplate/blob/main/LICENSE.txt)\n[![NPM Downloads](https://img.shields.io/npm/dt/html5-boilerplate.svg)](https://www.npmjs.com/package/html5-boilerplate)\n[![github-stars-image](https://img.shields.io/github/stars/h5bp/html5-boilerplate.svg?label=github%20stars)](https://github.com/h5bp/html5-boilerplate)\n\nHTML5 Boilerplate is a professional front-end template for building\nfast, robust, and adaptable web apps or sites.\n\nThis project is the product of over 10 years of iterative development and\ncommunity knowledge. It does not impose a specific development\nphilosophy or framework, so you're free to architect your code in the\nway that you want.\n\n- [Homepage](https://html5boilerplate.com/)\n- [Source Code](https://github.com/h5bp/html5-boilerplate)\n\n## About This Repository\n\nThis repository is where HTML5-Boilerplate is authored. Some of the tools,\nfiles and processes that you see here are solely for the _production_ of\nHTML5 Boilerplate and are not _part_ of HTML5 Boilerplate. For one example, the\n[gulpfile.mjs](https://github.com/h5bp/html5-boilerplate/blob/main/gulpfile.mjs)\nscript is used to _build_ the project. It's not part of the project itself.\n\nThe project we publish is represented by the contents of the `/dist/`\nfolder. Everything else in this repository is used to author the project.\n\nThink of it this way, in the same way that you don't clone [vuejs/core](https://github.com/vuejs/core)\nto create a Vue.js app, you don't need to clone this repository to start a new\nsite or app based on HTML5 Boilerplate.\n\nSo, if you're looking for a quick start template to build a website or\napplication, look at the options in the\n[Quick Start](https://github.com/h5bp/html5-boilerplate#quick-start) section of this document.\n\nIf you want to help us _improve_ HTML5 Boilerplate then you can start with the documentation [here](.github/CONTRIBUTING.md), which includes steps to clone this repo in order to get it set up for development.\n\n## Quick Start\n\nChoose one of the following options:\n\n- Using the [create-html5-boilerplate](https://github.com/h5bp/create-html5-boilerplate)\n script, instantly fetch the latest npm published package (or any version\n available on npm) with `npx`, `npm init` or `yarn create` without having to\n install any dependencies. Running the following `npx` command installs the\n latest version into a folder called `new-site`\n\n ```bash\n npx create-html5-boilerplate new-site\n cd new-site\n npm install\n npm run start\n ```\n\n- Using our new [Template Repository](https://github.com/h5bp/html5-boilerplate-template)\n create a new GitHub repository based on the latest code from the main branch of HTML5\n Boilerplate.\n\n- Install with [npm](https://www.npmjs.com/): `npm install html5-boilerplate`\n or [yarn](https://yarnpkg.com/): `yarn add html5-boilerplate`. The resulting\n `node_modules/html5-boilerplate/dist` folder represents the latest version of\n the project for end users. Depending on what you want to use and how you want\n to use it, you may have to copy and paste the contents of that folder into\n your project directory.\n\n- Download the latest stable release from\n [here](https://github.com/h5bp/html5-boilerplate/releases/download/v9.0.0/html5-boilerplate_v9.0.0.zip). This zip file is a\n snapshot of the `dist` folder. On Windows, Mac and from the file manager on\n Linux unzipping this folder will output to a folder named something like\n `html5-boilerplate_v9.0.0`. From the command-line, you will need to create a\n folder and unzip the contents into that folder.\n\n ```bash\n mkdir html5-boilerplate\n unzip html5-boilerplate*.zip -d html5-boilerplate\n ```\n\n## Features\n\n- A finely-tuned starter template: Reap the benefits of 10 years of analysis,\n research and experimentation by over 200 contributors.\n- Designed with progressive enhancement in mind.\n- Includes:\n - Placeholder Open Graph elements and attributes.\n - An example package.json file with [WebPack](https://webpack.js.org/) commands\n built in to jumpstart application development.\n - Placeholder CSS Media Queries.\n - Useful CSS helper classes.\n - Default print styles, performance optimized.\n - \"Delete-key friendly.\" Easy to strip out parts you don't need.\n - Extensive documentation.\n\n## Browser Support\n\nHTML5-Boilerplate supports the latest, stable releases of all major browsers.\n\nCheck the `default` configuration from [Browserslist](https://browsersl.ist/#q=defaults)\nfor more details on browsers and versions covered.\n\n## Documentation\n\nTake a look at the [documentation table of contents](docs/TOC.md). This\ndocumentation is bundled with the project which makes it available for offline\nreading and provides a useful starting point for any documentation you want to\nwrite about your project.\n\n## Contributing\n\nHundreds of developers have helped to make the HTML5 Boilerplate. Anyone is\nwelcome to [contribute](.github/CONTRIBUTING.md). However, if you decide to get\ninvolved, please take a moment to review the [guidelines](.github/CONTRIBUTING.md):\n\n- [Bug reports](.github/CONTRIBUTING.md#bugs)\n- [Feature requests](.github/CONTRIBUTING.md#features)\n- [Pull requests](.github/CONTRIBUTING.md#pull-requests)\n\n## License\n\nThe code is available under the [MIT license](LICENSE.txt).\n" }, { "path": "docs/TOC.md", "content": "[HTML5 Boilerplate homepage](https://html5boilerplate.com/)\n\n## Getting started\n\n- [Usage](usage.md) — Overview of the project contents.\n- [FAQ](faq.md) — Frequently asked questions along with their answers.\n\n## HTML5 Boilerplate core\n\n- [HTML](html.md) — Guide to the default HTML.\n- [CSS](css.md) — Guide to the default CSS.\n- [JavaScript](js.md) — Guide to the default JavaScript.\n- [Everything else](misc.md).\n\n## Development\n\n- [Extending and customizing HTML5 Boilerplate](extend.md) — Going further with\n the boilerplate.\n\n## Related projects\n\nThe [H5BP organization](https://github.com/h5bp) maintains several projects that\ncomplement HTML5 Boilerplate, projects that can help you improve different\naspects of your website/web app (e.g.: the performance, security, etc.).\n\n- [Server Configs](https://github.com/h5bp/server-configs) — Fast and smart\n configurations for web servers such as Apache and Nginx.\n - [Apache](https://github.com/h5bp/server-configs-apache)\n - [Google App Engine (GAE)](https://github.com/h5bp/server-configs-gae)\n - [Internet Information Services\n (IIS)](https://github.com/h5bp/server-configs-iis)\n - [lighttpd](https://github.com/h5bp/server-configs-lighttpd)\n - [Nginx](https://github.com/h5bp/server-configs-nginx)\n - [Node.js](https://github.com/h5bp/server-configs-node)\n- [Front-end Developer Interview Questions](https://github.com/h5bp/Front-end-Developer-Interview-Questions)\n- [create-html5-boilerplate](https://github.com/h5bp/create-html5-boilerplate) — Quick start HTML5 Boilerplate development.\n- [main.css](https://github.com/h5bp/main.css) — the main.css file included (as style.css) with HTML5 Boilerplate.\n" }, { "path": "docs/about-this-repo.md", "content": "# About This Repo\n\nThis document outlines the configuration of this repo as well as the basic\nprocess we use to manage the project. As GitHub has matured as a platform\nand HTML5 Boilerplate has matured as a project there are a lot of lessons\nto be learned from the way we run the show here.\n\n## GitHub configuration\n\nThis section will go through the way we configure the repo in GitHub.\nOpen source projects get the full power of the platform and as a project\nwe like to experiment with new GitHub features. Our current configuration\nmight help you figure out some things you want to do in your own projects.\n\n### General Configuration\n\nThis section outlines the basic configuration options we use.\n\n- We have a stub of a Wiki still, so we have wikis turned on. The most\n interesting page that remains is a history of the project written several\n years ago.\n- We use the Issues feature heavily. We don't yet have Issue Templates set\n up, but we do have adding them as an issue, so we'll take advantage of them\n at some point.\n- Discussions are enabled, but they haven't been very useful so far.\n\n### Pull Requests\n\nThe most visible portion of our configuration is the way we handle pull\nrequests. At the most basic level, we require pull requests to add code\nto the repo and require a review to merge code. In addition we run several\ncode quality checks on every pull request to make sure we're not introducing\nanything we don't want into the codebase.\n\nWe take advantage of the \"draft\" feature for PRs. This way we have visibility\nthroughout the life of the PR.\n\nLet's take a look at how we configure our `main` branch.\n\n#### `main`\n\n`main` is the default branch and is our only protected branch. We use feature\nbranches to add features and/or fix issues in the codebase. Other project\nconfigurations might require a long-running, similarly protected, `development`\nbranch but for us the single protected `main` branch is enough for our\npurposes.\n\nOur branch protection rules are as follows:\n\n- We require a pull request (PR) with one approving reviewer to merge code\n- In addition to the PR and approving reviewer, we require three status checks\n to pass before code can be merged\n _ Build with Node 20\n _ Build with Node 22\n _ Build with Node 24\n- We _allow_ force pushes for project admins. While force pushes can create\n some head scratching moments for people who have cloned the repo and update\n before and after the force push, the ability to clean up the `HEAD` of a\n public branch like this in an emergency is useful.\n\n#### GitHub Actions and Other Checks That Run on `main`\n\n- We run a simple _build status_ check. This is the most basic test you can run\n and is absolutely vital. If you can't build your project you're in trouble.\n Currently we're testing against Node 16 and 18.\n- We take advantage of our access to _CodeQL analysis_ Free for research and\n open source don't you know :) We don't have a ton of surface area to cover,\n but it's nice to have this powerful code scanning tool available to us.\n- We run a _dependency review_ scan to see if any newly added dependencies add\n known security flaws. This is important for even us, but for a project that\n uses a larger number of third party dependencies, this sort of check is vital.\n- We also run a CodeQL scans to check for security issues and problems.\n- We push any changes to `main` to our [HTML5\\-Boilerplate Template Repo](https://github.com/h5bp/html5-boilerplate-template)\n\nSince we've talked about some of our Actions, let's look at the full configuration\nof our `.github` folder.\n\n### .github Folder\n\n- workflows\n - `build-dist.yml` is currently broken. We can't push to `main` without a\n code review, so this task is blocked. What I would like, (are you there,\n GitHub, it's me, Rob) is to allow Actions to bypass branch protection\n rules. I think we'll have to basically write a mini-bot that opens a PR\n whenever there are changes to `main` and then pushes to the same branch\n until the PR is closed. In some ways that will be better as it will be less\n noisy in terms of bot pushes to main.\n - `codeql-analysis.yml` controls our CodeQL action. We use the defaults. If\n you're building something with more JavaScript footprint, you can tweak\n the settings for this job.\n - `dependency-review.yml` does what it says on the tin- it tests newly\n introduced dependencies for vulnerabilities.\n - `publish.yml` is the action that publishes all the various versions of\n the project. When we create a new tag and push it to GitHub, this script\n publishes our npm package and creates a GitHub release and attaches a zip\n file of our `dist` folder.\n - `push-to-template.yml` pushes the `HEAD` of `main` to our template repo\n - `spellcheck.yml` automatically checks markdown files for typos with cSpell.\n - `test.yml` runs our test suite on Ubuntu.\n - `test-windows.yml` runs our test suite on Windows.\n- `CODE_OF_CONDUCT.md` is our Code of Conduct, based on\n [Contributor Covenant.](https://www.contributor-covenant.org/)\n- `CONTRIBUTING.md` contains our contribution guidelines.\n- `ISSUE_TEMPLATE.md` is our new issue boilerplate.\n- `PULL_REQUEST_TEMPLATE.md` is our new PR boilerplate.\n- `SUPPORT.md` points people to different (non-HTML5-Boilerplate) support\n resources\n- `dependabot.yml` is our Dependabot configuration. We do `npm`, monthly on\n two separate `package.json` files, one in `src` and one in project root.\n\n---\n\nThat covers most of the interesting GitHub features and functionality that we\nuse. We're going to continue to keep this document up to date as we change\nthings or new GitHub features.\n" }, { "path": "docs/css.md", "content": "[HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation\ntable of contents](TOC.md)\n\n# The CSS\n\nHTML5 Boilerplate's CSS includes:\n\n- [style.css](#stylecss)\n\n## style.css\n\nSeveral base styles are included. These styles:\n\n- provide basic typography settings that improve text readability\n- protect against unwanted `text-shadow` during text highlighting\n- tweak the default alignment of some elements (e.g.: `img`, `video`,\n `fieldset`, `textarea`)\n- style the prompt that is displayed to users using an outdated browser\n- and more...\n\nThese styles are included in\n[style.css](https://github.com/h5bp/html5-boilerplate/blob/main/dist/css/style.css).\n" }, { "path": "docs/extend.md", "content": "[HTML5 Boilerplate homepage](https://html5boilerplate.com) | [Documentation\ntable of contents](TOC.md)\n\n# Extend and customize HTML5 Boilerplate\n\nHere is some useful advice for how you can make your project with HTML5\nBoilerplate even better. We don't want to include it all by default, as not\neverything fits with everyone's needs.\n\n- [Server Configuration](#server-configuration)\n- [App Stores](#app-stores)\n- [DNS prefetching](#dns-prefetching)\n- [Miscellaneous](#miscellaneous)\n- [News Feeds](#news-feeds)\n- [Search](#search)\n- [Social Networks](#social-networks)\n- [URLs](#urls)\n- [Web Apps](#web-apps)\n- [security.txt](#securitytxt)\n\n## Server Configuration\n\nWe no longer include a [`.htaccess`](#htaccess) file for the [Apache HTTP\nserver](https://httpd.apache.org/docs/) in HTML5 Boilerplate by default, however if you are\nusing a web server, then we encourage you to checkout out the [server configuration](https://github.com/h5bp/server-configs)\nthat corresponds to your web server and environment.\n\nThese repos offer a collection of configuration snippets that can help your server improve the\nwebsite's performance and security, while also ensuring that resources are served with the\ncorrect content-type and are accessible, if needed, even cross-domain.\n\n## App Stores\n\n### Smart App Banners in iOS 6+ Safari\n\nStop bothering everyone with gross modals advertising your entry in the App\nStore. Including the following [meta\ntag](https://developer.apple.com/documentation/webkit/promoting_apps_with_smart_app_banners)\nwill unobtrusively give the user the option to download your iOS app, or open it\nwith some data about the user's current state on the website.\n\n```html\n\n```\n\n## DNS prefetching\n\nIn short, DNS Prefetching is a method of informing the browser of domain names\nreferenced on a site so that the client can resolve the DNS for those hosts,\ncache them, and when it comes time to use them, have a faster turn around on the\nrequest.\n\n### Implicit prefetches\n\nThere is a lot of prefetching done for you automatically by the browser. When\nthe browser encounters an anchor in your HTML that does not share the same\ndomain name as the current location the browser requests, from the client OS,\nthe IP address for this new domain. The client first checks its cache and then,\nlacking a cached copy, makes a request from a DNS server. These requests happen\nin the background and are not meant to block the rendering of the page.\n\nThe goal of this is that when the foreign IP address is finally needed it will\nalready be in the client cache and will not block the loading of the foreign\ncontent. Fewer requests result in faster page load times. The perception of this\nis increased on a mobile platform where DNS latency can be greater.\n\n### Explicit prefetches\n\nTypically the browser only scans the HTML for foreign domains. If you have\nresources that are outside of your HTML (a JavaScript request to a remote server\nor a CDN that hosts content that may not be present on every page of your site,\nfor example) then you can queue up a domain name to be prefetched.\n\n```html\n\n\n```\n\nYou can use as many of these as you need, but it's best if they are all\nimmediately after the [Meta\nCharset](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta#attr-charset)\nelement (which should go right at the top of the `head`), so the browser can act\non them ASAP.\n\n### Further reading about DNS prefetching\n\n- https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-DNS-Prefetch-Control\n- https://dev.chromium.org/developers/design-documents/dns-prefetching\n\n## Search\n\n### Direct search spiders to your sitemap\n\nAfter creating a [sitemap](https://www.sitemaps.org/protocol.html)\n\nSubmit it to search engine tool:\n\n- [Google](https://www.google.com/webmasters/tools/sitemap-list)\n- [Bing](https://www.bing.com/toolbox/webmaster)\n- [Yandex](https://webmaster.yandex.com/)\n- [Baidu](https://zhanzhang.baidu.com/) OR Insert the following line anywhere in\n your robots.txt file, specifying the path to your sitemap:\n\n```\nSitemap: https://example.com/sitemap_location.xml\n```\n\n### Hide pages from search engines\n\nAccording to Heather Champ, former community manager at Flickr, you should not\nallow search engines to index your \"Contact Us\" or \"Complaints\" page if you\nvalue your sanity. This is an HTML-centric way of achieving that.\n\n```html\n\n```\n\n**_WARNING:_** DO NOT INCLUDE ON PAGES THAT SHOULD APPEAR IN SEARCH ENGINES.\n\n### Search Plugins\n\nSites with in-site search functionality should be strongly considered for a\nbrowser search plugin. A \"search plugin\" is an XML file which defines how your\nplugin behaves in the browser. [How to make a browser search\nplugin](https://developer.mozilla.org/en-US/docs/Web/OpenSearch).\n\n```html\n\n```\n\n## Miscellaneous\n\n- Use [Microformats](https://microformats.org/wiki/Main_Page) (via\n [microdata](https://microformats.org/wiki/microdata)) for optimum search\n results\n [visibility](https://developers.google.com/search/blog/2009/05/introducing-rich-snippets).\n\n- If you want to disable the translation prompt in Chrome or block Google\n Translate from translating your web page, use [``](https://developers.google.com/search/docs/crawling-indexing/special-tags).\n To disable translation for a particular section of the web page, add\n [`class=\"notranslate\"`](https://support.google.com/translate/?hl=en#2641276).\n\n- If you want to disable the automatic detection and formatting of possible\n phone numbers in Safari on iOS, use [``](https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html).\n\n- Avoid development/stage websites \"leaking\" into SERPs (search engine results\n page) by [implementing X-Robots-tag\n headers](https://github.com/h5bp/html5-boilerplate/issues/804).\n\n- Apply JavaScript-dependent CSS styles using [the `scripting` media\n feature](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/scripting).\n Use `@media (scripting: none) { ... }` to target browsers with JavaScript\n disabled, or `@media (scripting: enabled) { ... }` to target browsers with\n JavaScript enabled. Using this technique also helps [avoid the\n FOUC](https://www.paulirish.com/2009/avoiding-the-fouc-v3/).\n\n## News Feeds\n\n### RSS\n\nHave an RSS feed? Link to it here. Want to [learn how to write an RSS feed from\nscratch](https://www.rssboard.org/rss-specification)?\n\n```html\n\n```\n\n### Atom\n\nAtom is similar to RSS, and you might prefer to use it instead of or in addition\nto it. [See what Atom's all\nabout]().\n\n```html\n\n```\n\n### Pingbacks\n\nYour server may be notified when another site links to yours. The href attribute\nshould contain the location of your pingback service.\n\n```html\n\n```\n\n- High-level explanation:\n https://codex.wordpress.org/Introduction_to_Blogging#Pingbacks\n- Step-by-step example case:\n https://www.hixie.ch/specs/pingback/pingback-1.0#TOC5\n- PHP pingback service:\n https://web.archive.org/web/20131211032834/http://blog.perplexedlabs.com/2009/07/15/xmlrpc-pingbacks-using-php/\n\n## Social Networks\n\n### Facebook Open Graph data\n\nYou can control the information that Facebook and others display when users\nshare your site. Below are just the most basic data points you might need. For\nspecific content types (including \"website\"), see [Facebook's built-in Open\nGraph content\ntemplates](https://developers.facebook.com/docs/sharing/opengraph/using-objects).\nTake full advantage of Facebook's support for complex data and activity by\nfollowing the [Open Graph\ntutorial](https://developers.facebook.com/docs/sharing/webmasters/getting-started).\n\nFor a reference of Open Graph's markup and properties, you may check [Facebook's\nOpen Graph Protocol reference](https://ogp.me). Finally, you can validate your\nmarkup with the [Facebook Object\nDebugger](https://developers.facebook.com/tools/debug/) (needs registration to\nFacebook).\n\n```html\n\n\n\n\n\n\n\n\n\n\n```\n\n### Twitter Cards\n\nTwitter provides a snippet specification that serves a similar purpose to Open\nGraph. In fact, Twitter will use Open Graph when Cards is not available. You can\nread more about the various snippet formats in the\n[official Twitter Cards\ndocumentation](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards).\n\n```html\n\n\n\n\n\n\n\n```\n\n### Schema.org\n\nGoogle also provides a snippet specification that serves a similar purpose to\nFacebook's Open Graph or Twitter Cards. This metadata is a subset of\n[schema.org's microdata vocabulary](https://schema.org/), which covers many\nother schemas that can describe the content of your pages to search engines. For\nthis reason, this metadata is more generic for SEO, notably for Google's\nsearch-engine, although this vocabulary is also used by Microsoft, Pinterest and\nYandex.\n\nYou can validate your markup with the [Structured Data Testing\nTool](https://developers.google.com/search/docs/appearance/structured-data). Also, please\nnote that this markup requires to add attributes to your top `html` tag.\n\n```html\n\n \n\n \n \n \n \n \n```\n\n## URLs\n\n### Canonical URL\n\nSignal to search engines and others \"Use this URL for this page!\" Useful when\nparameters after a `#` or `?` is used to control the display state of a page.\n`https://www.example.com/cart.html?shopping-cart-open=true` can be indexed as\nthe cleaner, more accurate `https://www.example.com/cart.html`.\n\n```html\n\n```\n\n## Web Apps\n\nThere are a couple of meta tags that provide information about a web app when\nadded to the Home Screen on iOS:\n\n- Adding `apple-mobile-web-app-capable` will make your web app chrome-less and\n provide the default iOS app view. You can control the color scheme of the\n default view by adding `apple-mobile-web-app-status-bar-style`.\n\n```html\n\n\n```\n\n- You can use `apple-mobile-web-app-title` to add a specific sites name for the\n Home Screen icon.\n\n```html\n\n```\n\nFor further information please read the [official\ndocumentation](https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html)\non Apple's site.\n\n### Apple Touch Icons\n\nApple touch icons are used as icons when a user adds your webapp to the home\nscreen of an iOS devices.\n\nThough the dimensions of the icon can vary between iOS devices and versions one\n`180×180px` touch icon named `icon.png` and including the following in the\n`` of the page is enough:\n\n```html\n\n```\n\nFor a more comprehensive overview, please refer to Mathias' [article on Touch\nIcons](https://mathiasbynens.be/notes/touch-icons).\n\n### Apple Touch Startup Image\n\nApart from that it is possible to add start-up screens for web apps on iOS. This\nbasically works by defining `apple-touch-startup-image` with an according link\nto the image. Since iOS devices have different screen resolutions it maybe\nnecessary to add media queries to detect which image to load. Here is an example\nfor an iPhone:\n\n```html\n\n```\n\n### Theme Color\n\nYou can add the [`theme-color` meta\nextension](https://html.spec.whatwg.org/multipage/semantics.html#meta-theme-color)\nin the `` of your pages to suggest the color that browsers and OSes should\nuse if they customize the display of individual pages in their UIs with varying\ncolors.\n\n```html\n\n```\n\nThe `content` attribute extension can take any valid CSS color.\n\nFor browser support details, refer to [Can I Use](https://caniuse.com/meta-theme-color).\n\n### security.txt\n\nWhen security risks in web services are discovered by users they often lack the\nchannels to disclose them properly. As a result, security issues may be left\nunreported.\n\nSecurity.txt defines a standard to help organizations define the process for\nusers to disclose security vulnerabilities securely. Include a text file on your\nserver at `.well-known/security.txt` with the relevant contact details.\n\nCheck [https://securitytxt.org/](https://securitytxt.org/) for more details.\n" }, { "path": "docs/faq.md", "content": "[HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation\ntable of contents](TOC.md)\n\n# Frequently asked questions\n\n## Do I need to upgrade my site each time a new version of HTML5 Boilerplate is released?\n\nNo, just as you don't normally replace the foundation of a house once it was\nbuilt. However, there is nothing stopping you from trying to work in the latest\nchanges, but you'll have to assess the costs/benefits of doing so.\n\n## Where can I get help with support questions?\n\nPlease ask for help on\n[Stack Overflow](https://stackoverflow.com/questions/tagged/html5boilerplate).\n" }, { "path": "docs/html.md", "content": "[HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation\ntable of contents](TOC.md)\n\n# The HTML\n\nBy default, HTML5 Boilerplate provides two `html` pages:\n\n- [`index.html`](#indexhtml) - a default HTML skeleton that should form the\n basis of all pages on your website\n- `404.html` - a placeholder 404 error page\n\n## `index.html`\n\n### Language Attribute\n\nPlease consider specifying the language of your content by adding a\n[value](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry)\nto the `lang` attribute in the `` as in this example:\n\n```html\n\n```\n\n### The order of the `` and `<meta>` tags\n\nThe charset declaration (`<meta charset=\"utf-8\">`) must be included completely\nwithin the\n[first 1024 bytes of the document](https://html.spec.whatwg.org/multipage/semantics.html#charset)\nand should be specified as early as possible.\n\n### Meta Description\n\nThe `description` meta tag provides a short description of the page. In some\nsituations this description is used as a part of the snippet shown in the search\nresults.\n\n```html\n<meta name=\"description\" content=\"This is a description\">\n```\n\nGoogle's\n[Create good meta descriptions](https://support.google.com/webmasters/answer/35624?hl=en#meta-descriptions)\ndocumentation has useful tips on creating an effective description.\n\n### Mobile Viewport\n\nThere are a few different options that you can use with the\n[`viewport` meta tag](https://docs.google.com/present/view?id=dkx3qtm_22dxsrgcf4 \"Viewport and Media Queries - The Complete Idiot's Guide\").\nYou can find out more in [\nthe MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag).\nHTML5 Boilerplate comes with a simple setup that strikes a good balance for general use cases.\n\n```html\n<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n```\n\nIf you want to take advantage of edge-to-edge displays of iPhone X/XS/XR you\ncan do so with additional viewport parameters.\n[Check the WebKit blog](https://webkit.org/blog/7929/designing-websites-for-iphone-x/) for\ndetails.\n\n### Open Graph Metadata\n\nThe [Open Graph Protocol](https://ogp.me) allows you to define the way your\nsite is presented when referenced on third party sites and applications\n(Facebook, Twitter, LinkedIn). The protocol provides a series of meta elements\nthat define the details of your site. The required attributes define the title,\npreview image, URL, and [type](https://ogp.me/#types) (e.g., video, music,\nwebsite, article).\n\n```html\n<meta property=\"og:title\" content=\"\">\n<meta property=\"og:type\" content=\"\">\n<meta property=\"og:url\" content=\"\">\n<meta property=\"og:image\" content=\"\">\n<meta property=\"og:image:alt\" content=\"\">\n```\n\nIn addition to these four attributes there are many more attributes you can use\nto add more richness to the description of your site. This just represents the\nmost basic implementation.\n\nTo see a working example, the following is the open graph metadata for the HTML5\nBoilerplate site. In addition to the required fields we add `og:description` to\ndescribe the site in more detail.\n\n```html\n<meta property=\"og:url\" content=\"https://html5boilerplate.com/\">\n<meta property=\"og:title\" content=\"HTML5 ★ BOILERPLATE\">\n<meta property=\"og:type\" content=\"website\">\n<meta property=\"og:description\" content=\"The web’s most popular front-end template which helps you build fast, robust, and adaptable web apps or sites.\">\n<meta property=\"og:image\" content=\"https://html5boilerplate.com/icon.png\">\n<!-- Empty for decorative images. -->\n<meta property=\"og:image:alt\" content=\"\">\n```\n\n### Web App Manifest\n\nHTML5 Boilerplate includes a simple web app manifest file.\n\nThe web app manifest is a simple JSON file that allows you to control how your\napp appears on a device's home screen, what it looks like when it launches in\nthat context and what happens when it is launched. This allows for much greater\ncontrol over the UI of a saved site or web app on a mobile device.\n\nIt's linked to from the HTML as follows:\n\n```html\n<link rel=\"manifest\" href=\"site.webmanifest\">\n```\n\nOur\n[site.webmanifest](https://github.com/h5bp/html5-boilerplate/blob/main/src/site.webmanifest)\ncontains a very skeletal \"app\" definition, just to show the basic usage. You\nshould fill this file out with\n[more information about your site or application](https://developer.mozilla.org/en-US/docs/Web/Manifest)\n\n### Favicons and Touch Icon\n\nThe shortcut icons should be put in the root directory of your site.\n`favicon.ico` is automatically picked up by browsers if it's placed in the root.\nHTML5 Boilerplate comes with a default set of icons (include favicon and one\nApple Touch Icon) that you can use as a baseline to create your own.\n\nPlease refer to the more detailed description in the [Extend section](extend.md)\nof these docs.\n\n### The Content Area\n\nThe central part of the boilerplate template is pretty much empty. This is\nintentional, in order to make the boilerplate suitable for both web page and web\napp development.\n" }, { "path": "docs/js.md", "content": "[HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation\ntable of contents](TOC.md)\n\n# The JavaScript\n\nInformation about the default JavaScript included in the project.\n\n## app.js\n\nThis file can be used to contain or reference your site/app JavaScript code. If\nyou're working on something more advanced you might replace this file entirely.\nThat's cool.\n\n## vendor\n\nThis directory can be used to contain all third-party library code.\n" }, { "path": "docs/misc.md", "content": "[HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation\ntable of contents](TOC.md)\n\n# Miscellaneous\n\n- [.gitignore](#gitignore)\n- [.editorconfig](#editorconfig)\n- [robots.txt](#robotstxt)\n- [package.json](#packagejson)\n\n--\n\n## .gitignore\n\nHTML5 Boilerplate includes a basic project-level `.gitignore`. This should\nprimarily be used to avoid certain project-level files and directories from\nbeing kept under source control. Different development-environments will\nbenefit from different collections of ignores.\n\nOS-specific and editor-specific files should be ignored using a \"global\nignore\" that applies to all repositories on your system.\n\nFor example, add the following to your `~/.gitconfig`, where the `.gitignore`\nin your HOME directory contains the files and directories you'd like to\nglobally ignore:\n\n```gitignore\n[core]\n excludesfile = ~/.gitignore\n```\n\n- More on global ignores: [https://help.github.com/articles/ignoring-files/](https://help.github.com/en/github/using-git/ignoring-files)\n- Comprehensive set of ignores on GitHub: https://github.com/github/gitignore\n\n## .editorconfig\n\nThe `.editorconfig` file is provided in order to encourage and help you and\nyour team define and maintain consistent coding styles between different\neditors and IDEs.\n\nBy default, `.editorconfig` includes some basic\n[properties](https://editorconfig.org/#supported-properties) that reflect the\ncoding styles from the files provided by default, but you can easily change\nthem to better suit your needs.\n\nIn order for your editor/IDE to apply the\n[properties](https://editorconfig.org/#supported-properties) from the\n`.editorconfig` file, you may need to [install a\nplugin](https://editorconfig.org/#download).\n\n**N.B.** If you aren't using the server configurations provided by HTML5\nBoilerplate, we highly encourage you to configure your server to block\naccess to `.editorconfig` files, as they can disclose sensitive information!\n\nFor more details, please refer to the [EditorConfig\nproject](https://editorconfig.org/).\n\n## robots.txt\n\nThe `robots.txt` file is used to give instructions to web robots on what can\nbe crawled from the website.\n\nBy default, the file provided by this project includes the next two lines:\n\n- `User-agent: *` - the following rules apply to all web robots\n- `Disallow:` - everything on the website is allowed to be crawled\n\nIf you want to disallow certain pages you will need to specify the path in a\n`Disallow` directive (e.g.: `Disallow: /path`) or, if you want to disallow\ncrawling of all content, use `Disallow: /`.\n\nThe `/robots.txt` file is not intended for access control, so don't try to\nuse it as such. Think of it as a \"No Entry\" sign, rather than a locked door.\nURLs disallowed by the `robots.txt` file might still be indexed without being\ncrawled, and the content from within the `robots.txt` file can be viewed by\nanyone, potentially disclosing the location of your private content! So, if\nyou want to block access to private content, use proper authentication instead.\n\nFor more information about `robots.txt`, please see:\n\n- [robotstxt.org](https://www.robotstxt.org/)\n- [How Google handles the `robots.txt` file](https://developers.google.com/search/reference/robots_txt)\n\n## package.json\n\n`package.json` is used to define attributes of your site or application for\nuse in modern JavaScript development. [The full documentation is available](https://docs.npmjs.com/files/package.json)\nif you're interested. The fields we provide are as follows:\n\n- `title` - the title of your project. If you expect to publish your application\n to npm, then the name needs to follow [certain guidelines](https://docs.npmjs.com/files/package.json#name)\n and be unique.\n- `version` - indicates the version of your site application using semantic\n versioning ([SemVer](https://semver.org/))\n- `description` - describes your site.\n- `scripts` - is a JavaScript object containing commands that can be run in a\n node environment. There are many [built-in keys](https://docs.npmjs.com/misc/scripts)\n related to the package lifecycle that node understands automatically. You can\n also define custom scripts for use with your application development. We\n provide three custom scripts that work with webpack to get you up and running\n quickly with a bundler for your assets and a simple development server.\n\n - `start` serves your `index.html` with a simple development server\n\n- `keywords` - an array of keywords used to discover your app in the npm\n registry\n- `author` - defines the author of a package. There is also an alternative\n [contributors](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)\n field if there's more than one author.\n- `license` - the license for your application. Must conform to\n [specific rules](https://docs.npmjs.com/files/package.json#license)\n- `devDependencies` - development dependencies for your package. In our case\n we have several dependencies used by webpack, which we use as a simple development server.\n" }, { "path": "docs/usage.md", "content": "[HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation\ntable of contents](TOC.md)\n\n# Usage\n\nThe most basic usage of HTML5 Boilerplate is to create a static site or simple\napp. Once you've downloaded or cloned the project, that process looks something\nlike this:\n\n1. Set up the basic structure of the site.\n2. Add some content, style, and functionality.\n3. Run your site locally to see how it looks.\n4. Deploy your site.\n\nCool, right? _It is_. That said, the smart defaults, baseline elements, default\nattribute values and various other utilities that HTML5 Boilerplate offers can\nserve as the foundation for whatever you're interested in building.\n\nEven the basic use-case of a simple static site can be enhanced by manipulating\nthe code through an automated build process. Moving up in complexity HTML5\nBoilerplate can be integrated with whatever front-end framework, CMS or\ne-commerce platform you're working with. Mix-and-match to your heart's content.\nUse what you need (toss it in a blender if you need to) and discard the rest.\nHTML5 Boilerplate is a starting point, not a destination.\n\n## Basic structure\n\nA basic HTML5 Boilerplate site initially looks something like this:\n\n```\n.\n├── css\n│ └── style.css\n├── doc\n├── img\n├── js\n│ ├── app.js\n └── vendor\n├── .editorconfig\n├── 404.html\n├── favicon.ico\n├── icon.png\n├── icon.svg\n├── index.html\n├── package.json\n├── robots.txt\n├── site.webmanifest\n└── webpack.common.js\n└── webpack.config.dev.js\n└── webpack.config.prod.js\n```\n\nWhat follows is a general overview of each major part and how to use them.\n\n### css\n\nThis directory should contain all your project's CSS files. It includes some\ninitial CSS to help get you started from a solid foundation. [About the\nCSS](css.md).\n\n### doc\n\nThis directory contains all the HTML5 Boilerplate documentation. You can use it\nas the location and basis for your own project's documentation.\n\n### js\n\nThis directory should contain all your project's JS files. Libraries, plugins,\nand custom code can all be included here. It includes some initial JS to help\nget you started. [About the JavaScript](js.md).\n\n### 404.html\n\nA helpful custom 404 to get you started.\n\n### .editorconfig\n\nThe `.editorconfig` file is provided in order to encourage and help you and your\nteam to maintain consistent coding styles between different editors and IDEs.\n[Read more about the `.editorconfig` file](misc.md#editorconfig).\n\n### index.html\n\nThis is the default HTML skeleton that should form the basis of all pages on\nyour site. If you are using a server-side templating framework, then you will\nneed to integrate this starting HTML with your setup.\n\nMake sure that you update the URLs for the referenced CSS and JavaScript if you\nmodify the directory structure at all.\n\n### package.json\n\nEdit this file to describe your application, add dependencies, scripts and\nother properties related to node based development and the npm registry\n\n### robots.txt\n\nEdit this file to include any pages you need hidden from search engines.\n\n### Icons\n\nReplace the default `favicon.ico` and Apple Touch Icon with your own.\n\nIf you want to use different Apple Touch Icons for different resolutions please\nrefer to the [according documentation](extend.md#apple-touch-icons).\n\n### Webpack\n\nThe project contains a simple [webpack](https://webpack.js.org/) configuration.\n\nTo get started developing a site with a development server, run the following\ncommands from within the `/dist/` folder in the project's repo or within the\nroot folder of the dowloaded project files, the folder created by `npm install`\nor the project folder created by running [create\\-html5\\-boilerplate](https://github.com/h5bp/create-html5-boilerplate)\n\n```\nnpm install\nnpm run start\n```\n\nThis will start a Webpack development server with hot reloading of edited files.\n\nTo package a site for production run\n\n```\nnpm run build\n```\n\nThis command will bundle up the site's JavaScript and copy over static assets to\nthe newly created `dist` folder.\n\nThere are three files:\n\n#### webpack.common.js\n\nBoth the production and development scripts inherit from this common script.\n\n#### webpack.config.dev.js\n\nThis development configuration defines the behavior of development server.\n\n#### webpack.config.prod.js\n\nThis production configuration defines the behavior of the production build.\n\nIt copies the following files and folders to the dist folder:\n\n- css\n- img\n- js/vendor\n- 404.html\n- favicon.ico\n- icon.png\n- icon.svg\n- index.html\n- robots.txt\n- site.webmanifest\n\n`js/vendor` is copied over in order to allow you to use unprocessed JS files\nin addition to the files bundled based on the project's entry point `app.js.`\n" }, { "path": "eslint.config.mjs", "content": "import globals from 'globals';\nimport js from '@eslint/js';\nimport mocha from 'eslint-plugin-mocha';\nimport { defineConfig } from 'eslint/config';\n\nexport default defineConfig([\n {\n files: ['**/*.js'],\n plugins: {\n js,\n mocha,\n },\n languageOptions: {\n ecmaVersion: 2020,\n sourceType: 'module',\n globals: {\n ...globals.browser,\n ...globals.node,\n ...globals.mocha,\n },\n },\n extends: ['js/recommended'],\n rules: {\n // Your custom rules\n indent: ['error', 2],\n quotes: ['error', 'single'],\n semi: ['error', 'always'],\n },\n },\n]);\n" }, { "path": "gulpfile.mjs", "content": "import fs from 'fs';\nimport path from 'path';\nimport gulp from 'gulp';\nimport gulpAutoPrefixer from 'gulp-autoprefixer';\nimport gulpEslint from 'gulp-eslint-new';\nimport gulpHeader from 'gulp-header';\nimport gulpRename from 'gulp-rename';\nimport archiver from 'archiver';\nimport { globSync } from 'glob';\nimport { deleteSync } from 'del';\nimport { createRequire } from 'module';\nconst require = createRequire(import.meta.url);\nconst pkg = require('./package.json');\n\nconst dirs = pkg['h5bp-configs'].directories;\n\n// ---------------------------------------------------------------------\n// | Helper tasks |\n// ---------------------------------------------------------------------\n\ngulp.task('archive:create_archive_dir', (done) => {\n fs.mkdirSync(path.resolve(dirs.archive), '0755');\n done();\n});\n\ngulp.task('archive:zip', (done) => {\n const archiveName = path.resolve(\n dirs.archive,\n `${pkg.name}_v${pkg.version}.zip`,\n );\n const zip = archiver('zip');\n const files = globSync('**/*.*', {\n cwd: dirs.dist,\n ignore: [\n '**/node_modules/**',\n 'package-lock.json',\n '**/dist/**',\n '**/.cache/**',\n ],\n dot: true, // include hidden files\n });\n const output = fs.createWriteStream(archiveName);\n\n zip.on('error', (error) => {\n done();\n throw error;\n });\n\n output.on('close', done);\n\n files.forEach((file) => {\n const filePath = path.resolve(dirs.dist, file);\n\n // `zip.bulk` does not maintain the file\n // permissions, so we need to add files individually\n zip.append(fs.createReadStream(filePath), {\n name: file,\n mode: fs.statSync(filePath).mode,\n });\n });\n\n zip.pipe(output);\n zip.finalize();\n done();\n});\n\ngulp.task('clean', (done) => {\n deleteSync([dirs.archive, dirs.dist]);\n done();\n});\n\ngulp.task('copy:index.html', () => {\n return gulp.src(`${dirs.src}/index.html`).pipe(gulp.dest(dirs.dist));\n});\n\ngulp.task('copy:license', () =>\n gulp.src('LICENSE.txt').pipe(gulp.dest(dirs.dist)),\n);\n\ngulp.task('copy:style', () => {\n const banner = `/*! HTML5 Boilerplate v${pkg.version} | ${pkg.license} License | ${pkg.homepage} */\\n\\n`;\n\n return gulp\n .src('node_modules/main.css/dist/main.css')\n .pipe(gulpHeader(banner))\n .pipe(\n gulpAutoPrefixer({\n cascade: false,\n }),\n )\n .pipe(\n gulpRename({\n basename: 'style',\n }),\n )\n .pipe(gulp.dest(`${dirs.dist}/css`));\n});\n\ngulp.task('copy:misc', () =>\n gulp\n .src(\n [\n // Copy all files\n `${dirs.src}/**/*`,\n\n // Exclude the following files\n // (other tasks will handle the copying of these files)\n `!${dirs.src}/css/main.css`,\n `!${dirs.src}/index.html`,\n `!**/.DS_Store`,\n ],\n {\n encoding: false,\n // Include hidden files by default\n dot: true,\n },\n )\n .pipe(gulp.dest(dirs.dist)),\n);\n\ngulp.task('lint:js', () =>\n gulp\n .src([`${dirs.src}/js/*.js`, `${dirs.src}/*.js`, `${dirs.test}/*.mjs`])\n .pipe(gulpEslint())\n .pipe(gulpEslint.failOnError()),\n);\n\n// ---------------------------------------------------------------------\n// | Main tasks |\n// ---------------------------------------------------------------------\ngulp.task(\n 'copy',\n gulp.series('copy:index.html', 'copy:license', 'copy:style', 'copy:misc'),\n);\n\ngulp.task('build', gulp.series(gulp.parallel('clean', 'lint:js'), 'copy'));\n\ngulp.task(\n 'archive',\n gulp.series('build', 'archive:create_archive_dir', 'archive:zip'),\n);\n\ngulp.task('default', gulp.series('build'));\n" }, { "path": "package.json", "content": "{\n \"name\": \"html5-boilerplate\",\n \"version\": \"9.0.1\",\n \"description\": \"A professional front-end template for building fast, robust, and adaptable web apps or sites.\",\n \"keywords\": [\n \"h5bp\",\n \"template\",\n \"front-end\"\n ],\n \"homepage\": \"https://html5boilerplate.com/\",\n \"bugs\": {\n \"url\": \"https://github.com/h5bp/html5-boilerplate/issues\"\n },\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/h5bp/html5-boilerplate.git\"\n },\n \"license\": \"MIT\",\n \"files\": [\n \"CHANGELOG.md\",\n \"LICENSE.txt\",\n \"package.json\",\n \"dist/\",\n \"README.md\"\n ],\n \"scripts\": {\n \"build\": \"gulp build\",\n \"prettier\": \"prettier --write ./**/*.{js,json,md,mjs,yml}\",\n \"test\": \"gulp archive && mocha --reporter spec --timeout 5000\"\n },\n \"devDependencies\": {\n \"@eslint/js\": \"^9.35.0\",\n \"archiver\": \"^7.0.1\",\n \"del\": \"^8.0.1\",\n \"eslint\": \"^9.35.0\",\n \"eslint-plugin-mocha\": \"^11.1.0\",\n \"glob\": \"^11.1.0\",\n \"globals\": \"^16.4.0\",\n \"gulp\": \"^5.0.1\",\n \"gulp-autoprefixer\": \"^9.0.0\",\n \"gulp-eslint-new\": \"^2.4.0\",\n \"gulp-header\": \"^2.0.9\",\n \"gulp-rename\": \"^2.1.0\",\n \"main.css\": \"3.0.0\",\n \"mocha\": \"^11.7.2\",\n \"prettier\": \"3.6.2\"\n },\n \"engines\": {\n \"node\": \">=20\"\n },\n \"volta\": {\n \"node\": \"20.19.1\"\n },\n \"h5bp-configs\": {\n \"directories\": {\n \"archive\": \"archive\",\n \"dist\": \"dist\",\n \"src\": \"src\",\n \"test\": \"test\"\n }\n }\n}\n" }, { "path": "src/.editorconfig", "content": "# editorconfig.org\n\nroot = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\nindent_size = 2\nindent_style = space\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n" }, { "path": "src/.gitattributes", "content": "## GITATTRIBUTES FOR WEB PROJECTS\n#\n# These settings are for any web project.\n#\n# Details per file setting:\n# text These files should be normalized (i.e. convert CRLF to LF).\n# binary These files are binary and should be left untouched.\n#\n# Note that binary is a macro for -text -diff.\n######################################################################\n\n## AUTO-DETECT\n## Handle line endings automatically for files detected as\n## text and leave all files detected as binary untouched.\n## This will handle all files NOT defined below.\n* text=auto\n\n## SOURCE CODE\n*.bat text eol=crlf\n*.coffee text\n*.css text\n*.htm text\n*.html text\n*.inc text\n*.ini text\n*.js text\n*.json text\n*.jsx text\n*.less text\n*.od text\n*.onlydata text\n*.php text\n*.pl text\n*.py text\n*.rb text\n*.sass text\n*.scm text\n*.scss text\n*.sh text eol=lf\n*.sql text\n*.styl text\n*.tag text\n*.ts text\n*.tsx text\n*.xml text\n*.xhtml text\n\n## DOCKER\n*.dockerignore text\nDockerfile text\n\n## DOCUMENTATION\n*.markdown text\n*.md text\n*.mdwn text\n*.mdown text\n*.mkd text\n*.mkdn text\n*.mdtxt text\n*.mdtext text\n*.txt text\nAUTHORS text\nCHANGELOG text\nCHANGES text\nCONTRIBUTING text\nCOPYING text\ncopyright text\n*COPYRIGHT* text\nINSTALL text\nlicense text\nLICENSE text\nNEWS text\nreadme text\n*README* text\nTODO text\n\n## TEMPLATES\n*.dot text\n*.ejs text\n*.haml text\n*.handlebars text\n*.hbs text\n*.hbt text\n*.jade text\n*.latte text\n*.mustache text\n*.njk text\n*.phtml text\n*.tmpl text\n*.tpl text\n*.twig text\n\n## LINTERS\n.babelrc text\n.csslintrc text\n.eslintrc text\n.htmlhintrc text\n.jscsrc text\n.jshintrc text\n.jshintignore text\n.prettierrc text\n.stylelintrc text\n\n## CONFIGS\n*.bowerrc text\n*.cnf text\n*.conf text\n*.config text\n.browserslistrc text\n.editorconfig text\n.gitattributes text\n.gitconfig text\n.gitignore text\n.htaccess text\n*.npmignore text\n*.yaml text\n*.yml text\nbrowserslist text\nMakefile text\nmakefile text\n\n## HEROKU\nProcfile text\n.slugignore text\n\n## GRAPHICS\n*.ai binary\n*.bmp binary\n*.eps binary\n*.gif binary\n*.ico binary\n*.jng binary\n*.jp2 binary\n*.jpg binary\n*.jpeg binary\n*.jpx binary\n*.jxr binary\n*.pdf binary\n*.png binary\n*.psb binary\n*.psd binary\n*.svg text\n*.svgz binary\n*.tif binary\n*.tiff binary\n*.wbmp binary\n*.webp binary\n\n## AUDIO\n*.kar binary\n*.m4a binary\n*.mid binary\n*.midi binary\n*.mp3 binary\n*.ogg binary\n*.ra binary\n\n## VIDEO\n*.3gpp binary\n*.3gp binary\n*.as binary\n*.asf binary\n*.asx binary\n*.fla binary\n*.flv binary\n*.m4v binary\n*.mng binary\n*.mov binary\n*.mp4 binary\n*.mpeg binary\n*.mpg binary\n*.ogv binary\n*.swc binary\n*.swf binary\n*.webm binary\n\n## ARCHIVES\n*.7z binary\n*.gz binary\n*.jar binary\n*.rar binary\n*.tar binary\n*.zip binary\n\n## FONTS\n*.ttf binary\n*.eot binary\n*.otf binary\n*.woff binary\n*.woff2 binary\n\n## EXECUTABLES\n*.exe binary\n*.pyc binary\n" }, { "path": "src/.gitignore", "content": "# Include your project-specific ignores in this file\n# Read about how to use .gitignore: https://help.github.com/articles/ignoring-files\n# Useful .gitignore templates: https://github.com/github/gitignore\nnode_modules\ndist\n.cache" }, { "path": "src/404.html", "content": "<!doctype html>\n<html lang=\"en\">\n\n<head>\n <meta charset=\"utf-8\">\n <title>Page Not Found\n \n \n\n\n\n

Page Not Found

\n

Sorry, but the page you were trying to view does not exist.

\n\n\n\n\n" }, { "path": "src/img/.gitkeep", "content": "" }, { "path": "src/index.html", "content": "\n\n\n\n \n \n \n \n \n\n \n \n \n \n \n\n \n \n \n\n \n \n\n\n\n\n \n

Hello world! This is HTML5 Boilerplate.

\n \n\n\n\n\n" }, { "path": "src/js/app.js", "content": "" }, { "path": "src/js/vendor/.gitkeep", "content": "" }, { "path": "src/package.json", "content": "{\n \"name\": \" \",\n \"version\": \"0.0.1\",\n \"description\": \"\",\n \"private\": true,\n \"keywords\": [\n \"\"\n ],\n \"license\": \"\",\n \"author\": \"\",\n \"scripts\": {\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\",\n \"start\": \"webpack serve --open --config webpack.config.dev.js\",\n \"build\": \"webpack --config webpack.config.prod.js\"\n },\n \"devDependencies\": {\n \"copy-webpack-plugin\": \"^13.0.1\",\n \"html-webpack-plugin\": \"^5.6.4\",\n \"webpack\": \"^5.101.3\",\n \"webpack-cli\": \"^6.0.1\",\n \"webpack-dev-server\": \"^5.2.2\",\n \"webpack-merge\": \"^6.0.1\"\n }\n}\n" }, { "path": "src/robots.txt", "content": "# https://www.robotstxt.org/\n\n# Allow crawling of all content\nUser-agent: *\nDisallow:\n" }, { "path": "src/site.webmanifest", "content": "{\n \"short_name\": \"\",\n \"name\": \"\",\n \"icons\": [{\n \"src\": \"icon.png\",\n \"type\": \"image/png\",\n \"sizes\": \"192x192\"\n }],\n \"start_url\": \"/?utm_source=homescreen\",\n \"background_color\": \"#fafafa\",\n \"theme_color\": \"#fafafa\"\n}\n" }, { "path": "src/webpack.common.js", "content": "const path = require('path');\n\nmodule.exports = {\n entry: {\n app: './js/app.js',\n },\n output: {\n path: path.resolve(__dirname, 'dist'),\n clean: true,\n filename: './js/app.js',\n },\n};\n" }, { "path": "src/webpack.config.dev.js", "content": "const { merge } = require('webpack-merge');\nconst common = require('./webpack.common.js');\n\nmodule.exports = merge(common, {\n mode: 'development',\n devtool: 'inline-source-map',\n devServer: {\n liveReload: true,\n hot: true,\n open: true,\n static: ['./'],\n },\n});\n" }, { "path": "src/webpack.config.prod.js", "content": "const { merge } = require('webpack-merge');\nconst common = require('./webpack.common.js');\nconst HtmlWebpackPlugin = require('html-webpack-plugin');\nconst CopyPlugin = require('copy-webpack-plugin');\n\nmodule.exports = merge(common, {\n mode: 'production',\n plugins: [\n new HtmlWebpackPlugin({\n template: './index.html',\n }),\n new CopyPlugin({\n patterns: [\n { from: 'img', to: 'img' },\n { from: 'css', to: 'css' },\n { from: 'js/vendor', to: 'js/vendor' },\n { from: 'icon.svg', to: 'icon.svg' },\n { from: 'favicon.ico', to: 'favicon.ico' },\n { from: 'robots.txt', to: 'robots.txt' },\n { from: 'icon.png', to: 'icon.png' },\n { from: '404.html', to: '404.html' },\n { from: 'site.webmanifest', to: 'site.webmanifest' },\n ],\n }),\n ],\n});\n" }, { "path": "test/file_content.mjs", "content": "import assert from 'assert';\nimport fs from 'fs';\nimport path from 'path';\nimport { createRequire } from 'module';\nconst require = createRequire(import.meta.url);\nconst pkg = require('../package.json');\nconst dirs = pkg['h5bp-configs'].directories;\n\n// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n\nfunction checkString(file, string, done) {\n let character = '';\n let matchFound = false;\n let matchedPositions = 0;\n const readStream = fs.createReadStream(file, { encoding: 'utf8' });\n\n readStream.on('close', done);\n readStream.on('error', done);\n readStream.on('readable', function () {\n // Read file until the string is found\n // or the whole file has been read\n while (matchFound !== true && (character = readStream.read(1)) !== null) {\n if (character === string.charAt(matchedPositions)) {\n matchedPositions += 1;\n } else {\n matchedPositions = 0;\n }\n\n if (matchedPositions === string.length) {\n matchFound = true;\n }\n }\n\n assert.equal(true, matchFound);\n this.close();\n });\n}\n\n// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n\nfunction runTests() {\n const dir = dirs.dist;\n\n describe(`Test if the files from the \"${dir}\" directory have the expected content`, () => {\n it('\"style.css\" should contain a custom banner', function (done) {\n const string = `/*! HTML5 Boilerplate v${pkg.version} | ${pkg.license} License | ${pkg.homepage} */\\n`;\n checkString(path.resolve(dir, 'css/style.css'), string, done);\n });\n });\n}\n\nrunTests();\n" }, { "path": "test/file_existence.mjs", "content": "import assert from 'assert';\nimport fs from 'fs';\nimport path from 'path';\nimport { globSync } from 'glob';\nimport { createRequire } from 'module';\nconst require = createRequire(import.meta.url);\nconst pkg = require('../package.json');\nconst dirs = pkg['h5bp-configs'].directories;\n\nconst expectedFilesInArchiveDir = [`${pkg.name}_v${pkg.version}.zip`];\n\nconst expectedFilesInDistDir = [\n '.editorconfig',\n '.gitattributes',\n '.gitignore',\n '404.html',\n 'package.json',\n\n 'webpack.common.js',\n 'webpack.config.dev.js',\n 'webpack.config.prod.js',\n\n 'css/', // for directories, a `/` character\n // should be included at the end\n 'css/style.css',\n\n 'favicon.ico',\n\n 'icon.png',\n 'icon.svg',\n\n 'img/',\n 'img/.gitkeep',\n\n 'index.html',\n\n 'js/',\n 'js/app.js',\n 'js/vendor/',\n 'js/vendor/.gitkeep',\n 'LICENSE.txt',\n 'robots.txt',\n 'site.webmanifest',\n];\n\n// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n\nfunction checkFiles(directory, expectedFiles) {\n // Get the list of files from the specified directory\n const files = globSync('**/*', {\n cwd: directory,\n ignore: [\n '**/node_modules/**',\n 'package-lock.json',\n '**/dist/**',\n '**/.cache/**',\n ],\n dot: true, // include hidden files\n mark: true, // add a `/` character to directory matches,\n posix: true, //https://github.com/isaacs/node-glob/issues/467\n });\n\n // Check if all expected files are present in the\n // specified directory, and are of the expected type\n expectedFiles.forEach((file) => {\n let ok = false;\n const expectedFileType =\n file.slice(-1) !== '/' ? 'regular file' : 'directory';\n\n // If file exists\n if (files.indexOf(file) !== -1) {\n // Check if the file is of the correct type\n if (file.slice(-1) !== '/') {\n // Check if the file is really a regular file\n ok = fs.statSync(path.resolve(directory, file)).isFile();\n } else {\n // Check if the file is a directory\n // (Since glob adds the `/` character to directory matches,\n // we can simply check if the `/` character is present)\n ok = files[files.indexOf(file)].slice(-1) === '/';\n }\n }\n\n it(`\"${file}\" should be present and it should be a ${expectedFileType}`, () => {\n assert.equal(true, ok);\n });\n });\n\n // List all files that should be NOT\n // be present in the specified directory\n files\n .filter((file) => {\n return expectedFiles.indexOf(file) === -1;\n })\n .forEach((file) => {\n it(`\"${file}\" should NOT be present`, () => {\n assert(false);\n });\n });\n}\n\n// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n\nfunction runTests() {\n describe('Test if all the expected files, and only them, are present in the build directories', () => {\n describe(dirs.archive, () => {\n checkFiles(dirs.archive, expectedFilesInArchiveDir);\n });\n\n describe(dirs.dist, () => {\n checkFiles(dirs.dist, expectedFilesInDistDir);\n });\n });\n}\n\nrunTests();\n" } ]