Skip to content

Conversation

@bachand
Copy link
Contributor

@bachand bachand commented Nov 1, 2025

Summary

Screenshot 2025-10-31 at 9 08 43 PM Screenshot 2025-10-31 at 9 08 41 PM Screenshot 2025-10-31 at 9 08 36 PM

@@ -0,0 +1,56 @@
name: Deploy to GitHub Pages
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't tested this part.

@bachand bachand mentioned this pull request Nov 22, 2025
2 tasks
@bachand
Copy link
Contributor Author

bachand commented Nov 22, 2025

Closing in favor of #338.

@bachand bachand closed this Nov 22, 2025
bachand added a commit that referenced this pull request Dec 1, 2025
#### Summary

Adds the ability to convert the README.md to a website. This
productionizes #336 following
positive internal feedback on the direction.

The next steps will be to set up a GitHub workflow to publish the site
to GitHub Pages. We may also want to continue to polish the style.

#### Reasoning

A website will make the style guide more accessible. We chose to
generate the website from the README so that the existing workflow for
updating the style guide remains the same.


#### Testing

- [x] Run `bundle exec rake site:serve` locally and check the content at
http://localhost:4000
- [x] Verify that top badges and SPM command plugin sections are
filtered out of the site

| Top | Code block | Footer |
| --- | --- | --- |

|![image](https://github.com/user-attachments/assets/176cd61e-fb77-40ef-aa5c-8d25858eb883)
|
![image](https://github.com/user-attachments/assets/1c080b2a-2edd-4d7a-a674-ab1983cb61d4)
|
![image](https://github.com/user-attachments/assets/0f8bc71e-04ae-4719-97e3-7595635f6a18)
|


#### Please review

@airbnb/swift-styleguide-maintainers
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant