diff --git a/tech_docs/webdev/html_css_standards.md b/tech_docs/webdev/html_css_standards.md index 62cf7b5..36ee2cc 100644 --- a/tech_docs/webdev/html_css_standards.md +++ b/tech_docs/webdev/html_css_standards.md @@ -1,194 +1,296 @@ # Coding Standards Documentation ## Introduction -This document outlines the common HTML class naming conventions and structure to ensure consistent, readable, and maintainable code in our web projects. -## Buttons +This document outlines our **HTML class naming conventions** and **structural guidelines**. Adhering to these standards ensures **consistent, readable, and maintainable code** across all web projects. Our goal is to facilitate **seamless team collaboration**, **reduce development time**, and **improve long-term code maintainability**. -- `.btn`: - - **Description**: Used to style generic buttons. - - **Example**: `` -- `.btn--large`: - - **Description**: Styles large buttons. - - **Example**: `` -- `.btn--small`: - - **Description**: Styles small buttons. - - **Example**: `` +----- -## Layout +## HTML Class Naming Conventions -- `.container`: - - **Description**: Wraps the main content of a web page, centering the content and limiting its width. - - **Example**: `
`
-- **Strong Emphasis (``):** Denotes strong importance, typically displayed as bold.
- - **Usage**: `Important text.`
-- **Emphasis (``):** Gives emphasized text, usually rendered as italic.
- - **Usage**: `Emphasized text.`
-- **Code (``):** Designates a single line of code.
- - **Usage**: `let x = 10;`
-- **Span (``):** Generic inline container for phrasing content. Doesn't convey any meaning on its own.
- - **Usage**: `Highlighted text`
-- **Abbreviations (``):** Represents an abbreviation or acronym.
- - **Usage**: `HTML`
-- **Inline Quotation (``):** Denotes a short inline quotation.
- - **Usage**: `Cogito, ergo sum
`
-
-## Block Elements
-
-Block elements start on a new line and typically take up the full width of their parent container.
-
-Examples include:
-
-- **Paragraphs (``):** Denotes a block of text.
- - **Usage**: `
This is a paragraph.
`
-- **Headings (`` to ``):** Mark section headings, with `` being the most prominent and `` the least.
- - **Usage**:
- - `Main Title
`
- - `Subheading
`
- - ...
- - `Smallest Subheading
`
-- **Lists:**
- - **Unordered (``):** List without a specific order.
- - **Usage**:
- ```html
-
- - Apple
- - Banana
-
- ```
- - **Ordered (``):** Numbered list.
- - **Usage**:
- ```html
-
- - First item
- - Second item
-
- ```
- - **Description (``):** List of terms with their descriptions.
- - **Usage**:
- ```html
-
- - Browser
- - A software used to access the web.
-
- ```
-- **Divisions (``):** Generic container that groups content.
- - **Usage**: `...`
-- **Block Quotation (``):** Represents a section quoted from another source.
- - **Usage**:
+ * **`.form`**
+ * **Description**: Styles the **entire form container**, applying general layout and spacing rules to its elements.
+ * **Usage**: ``
+ * **`.form__group`**
+ * **Description**: Groups related form elements (e.g., a label and its input) for consistent vertical spacing.
+ * **Usage**:
```html
-
- This is a block quote from another source.
-
+
+
+
+
```
-- **Tables (``):** Represents tabular data.
- - **Usage**:
+ * **`.input`**
+ * **Description**: Applies **base styles to generic text-based input fields** (``, ``, `