{"id":27899520,"url":"https://github.com/webdiscus/html-bundler-docs","last_synced_at":"2026-02-09T08:36:18.589Z","repository":{"id":283379862,"uuid":"951407586","full_name":"webdiscus/html-bundler-docs","owner":"webdiscus","description":"Documentation for html-bundler-webpack-plugin","archived":false,"fork":false,"pushed_at":"2025-08-25T01:51:46.000Z","size":1238,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-27T20:54:53.167Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webdiscus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-19T16:20:20.000Z","updated_at":"2025-07-20T13:25:42.000Z","dependencies_parsed_at":"2025-05-05T19:45:19.259Z","dependency_job_id":"54a1825d-8da1-4273-a2df-dac60831a557","html_url":"https://github.com/webdiscus/html-bundler-docs","commit_stats":null,"previous_names":["webdiscus/html-bundler-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/webdiscus/html-bundler-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdiscus%2Fhtml-bundler-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdiscus%2Fhtml-bundler-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdiscus%2Fhtml-bundler-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdiscus%2Fhtml-bundler-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webdiscus","download_url":"https://codeload.github.com/webdiscus/html-bundler-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdiscus%2Fhtml-bundler-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29260097,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-09T04:11:57.159Z","status":"ssl_error","status_checked_at":"2026-02-09T04:11:56.117Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-05T19:35:30.883Z","updated_at":"2026-02-09T08:36:18.574Z","avatar_url":"https://github.com/webdiscus.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# html-bundler-webpack-plugin documentation style guide\n\nThis guide provides clear and concise instructions to help you create well-organized and readable documentation for\nthe html-bundler-webpack-plugin community. It covers organization, spelling, formatting, and more to ensure consistency\nand professionalism across all documents.\n\n## Table of contents\n\n1. [General Guidelines](#general-guidelines)\n1. [Writing Style](#writing-style)\n1. [Punctuation](#punctuation)\n1. [Document Structure](#document-structure)\n1. [API Documentation](#api-documentation)\n1. [Code Blocks](#code-blocks)\n1. [Formatting](#formatting)\n1. [Product and Project Naming](#product-and-project-naming)\n\n---\n\n## General guidelines\n\n### File naming\n\n- **Markdown Files:** Use `lowercase-with-dashes.md`.\n  - Use underscores only if they are part of the topic name (e.g., `child_process`).\n  - Some files, like top-level Markdown files, may be exceptions.\n\n### Text wrapping\n\n- Wrap documents at 120 characters per line to enhance readability and version control.\n\n### Editor configuration\n\n- Follow the formatting rules specified in `.editorconfig`.\n  - A [plugin][editorconfig-url] is available for some editors to enforce these rules.\n\n### Testing documentation\n\n- Validate documentation changes using `make test-doc -j` or `vcbuild test-doc`.\n\n---\n\n## Writing style\n\n### Spelling and grammar\n\n- **Spelling:** Use [US spelling][US spelling Url].\n- **Grammar:** Use clear, concise language. Avoid unnecessary jargon.\n\n### Commas\n\n- **Serial Commas:** Use [serial commas][serial commas] for clarity.\n  - Example: *apples, oranges\u003cb\u003e,\u003c/b\u003e and bananas*\n\n### Pronouns\n\n- Avoid first-person pronouns (*I*, *we*).\n\n### Gender-neutral language\n\n- Use gender-neutral pronouns and plural nouns.\n  - OK: *they*, *their*, *them*, *folks*, *people*, *developers*\n  - NOT OK: *his*, *hers*, *him*, *her*, *guys*, *dudes*\n\n### Terminology\n\n- Use precise technical terms and avoid colloquialisms.\n- Define any specialized terms or acronyms at first use.\n\n---\n\n## Punctuation\n\n### Terminal punctuation\n\n- Place inside parentheses or quotes if the content is a complete clause.\n- Place outside if the content is a fragment of a clause.\n\n### Quotation marks\n\n- Use double quotation marks for direct quotes.\n- Use single quotation marks for quotes within quotes.\n\n### Colons and semicolons\n\n- Use colons to introduce lists or explanations.\n- Use semicolons to link closely related independent clauses.\n\n---\n\n## Document structure\n\n### Headings\n\n- Start documents with a level-one heading (`#`).\n- Use subsequent headings (`##`, `###`, etc.) to organize content hierarchically.\n\n### Links\n\n- Prefer reference-style links (`[a link][link-url]`) over inline links (`[a link](http://example.com)`).\n- Use `url` suffix for reference-style link labels\n\n### Lists\n\n- Use bullet points for unordered lists and numbers for ordered lists.\n- Keep list items parallel in structure.\n\n### Tables\n\n- Use tables to present structured information clearly. Ensure they are readable in plain text.\n\n---\n\n## API documentation\n\n### Usage examples\n\n- Provide a usage example or a link to an example for every function.\n\n### Parameter descriptions\n\n- Clearly describe parameters and return values, including types and defaults.\n  - Example:\n\n    ```markdown\n    - `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.\n    ```\n\n---\n\n## Code blocks\n\n### Language-aware fences\n\n- Use language-aware fences (e.g., `` ```js ``) for code blocks.\n\n  - **Info String:** Use the appropriate info string from the following list:\n\n    | Language         | Info String  |\n    | ---------------- | ------------ |\n    | Bash             | `bash`       |\n    | CommonJS         | `cjs`        |\n    | Terminal Session | `console`    |\n    | Diff             | `diff`       |\n    | JavaScript       | `js`         |\n    | JSON             | `json`       |\n    | Markdown         | `markdown`   |\n    | EcmaScript       | `mjs`        |\n    | Powershell       | `powershell` |\n    | Plaintext        | `text`       |\n    | TypeScript       | `typescript` |\n\n  - Use `text` for unknown languages.\n\n### Code comments\n\n- Use comments to explain complex logic within code examples.\n- Follow the standard commenting style of the respective language.\n\n---\n\n## Formatting\n\n### Escaping characters\n\n- Use backslash-escaping for underscores, asterisks, and backticks: `\\_`, `\\*`, `` \\` ``.\n\n### Naming conventions\n\n- **Constructors:** Use PascalCase.\n- **Instances:** Use camelCase.\n- **Methods:** Indicate methods with parentheses: `socket.end()` instead of `socket.end`.\n\n### Function arguments and returns\n\n- **Arguments:**\n\n  ```markdown\n  - `name` {type|type2} Optional description. **Default:** `value`.\n  ```\n\n  Example:\n\n  ```markdown\n  - `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.\n  ```\n\n- **Returns:**\n\n  ```markdown\n  - Returns: {type|type2} Optional description.\n  ```\n\n  Example:\n\n  ```markdown\n  - Returns: {AsyncHook} A reference to `asyncHook`.\n  ```\n\n---\n\n## Product and project naming\n\n### Official styling\n\n- Use official capitalization for products and projects.\n  - OK: JavaScript, Google's V8, Node.js\n  - NOT OK: Javascript, Google's v8, Node, NodeJS\n\n### html-bundler-webpack-plugin references\n\n- Use *html-bundler-webpack-plugin* instead of similar variants.\n\n### Version references\n\n- Use *html-bundler-webpack-plugin* and the version number in prose. Do not prefix the version number with *v*.\n  - OK: *html-bundler-webpack-plugin 14.x*, *html-bundler-webpack-plugin 14.3.1*\n  - NOT OK: *html-bundler-webpack-plugin v14*\n\nFor topics not addressed here, please consult the [Microsoft Writing Style Guide][Microsoft Writing Style Guide Url].\n\n---\n\n[Microsoft Writing Style Guide Url]: https://learn.microsoft.com/en-us/style-guide/welcome/\n[US spelling Url]: https://learn.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words\n[editorconfig-url]: https://editorconfig.org/#download\n[serial commas]: https://learn.microsoft.com/en-us/style-guide/punctuation/commas\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdiscus%2Fhtml-bundler-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebdiscus%2Fhtml-bundler-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdiscus%2Fhtml-bundler-docs/lists"}