Skip to content

Remove legacy <span> tags used for inline styling in documentation #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
travisamartin opened this issue May 27, 2025 · 0 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@travisamartin
Copy link
Contributor

Description

We need to remove <span> tags used for inline styling in the NGINX documentation. These tags were originally introduced when WordPress was used to publish docs, but they are no longer necessary now that we apply styles via CSS.

Problem

Inline <span> tags with style attributes (e.g., style="color:#666666; font-weight:bolder; white-space: nowrap;") are still present in many places. This introduces unnecessary complexity, makes maintenance harder, and creates inconsistencies in formatting across the docs.

Example

Current HTML:

Image

Solution

  • Remove all inline <span> tags used solely for styling.
  • Replace them with Markdown formatting:
    • **bold** for UI labels and key terms
    • `inline code` for values
    • _italics_ if stylistically necessary

Rationale

  • Reduces maintenance overhead by eliminating inline style overrides
  • Simplifies content editing and review by using plain Markdown
  • Improves readability of source files in version control
  • Aligns with our current documentation standards and publishing system
  • Promotes visual and structural consistency across all docs

Priority

Medium – Not urgent, but important for long-term maintainability, content quality, and consistency.

@travisamartin travisamartin self-assigned this May 27, 2025
@travisamartin travisamartin added the documentation Improvements or additions to documentation label May 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant