ddev/ddev.com

ddev.com style guide?

Closed this issue · 2 comments

RowboTony commented

Hello, is there a style guide for the ddev.com website? For example, ddev readthedocs.io has a style guide.

I've forked a ddev.com repo to work on adding a blog post. I was trying to add something like a tip or warning to my blog post markdown such as:

!!!tip "This is a tip."
    Use it for helpful asides.

ddev-readthedocs

Here's the link if anyone wants to review. I hope to complete my commentary comparing traditional migration vs. AM:A by the end of this week.

https://github.com/RowboTony/ddev.com/blob/main/src/content/blog/acquia-migrate-accelerate-ama-on-ddev.md

Thank you,
--Tony

rfay commented

Thanks for working on the article @RowboTony !

The feature you're talking about is a feature of mkdocs-material, which isn't used by ddev.com (it is used by the docs).

Features like that aren't really related to a style guide though. A style guide typically tells you how to use language and standardize approaches.

But a style guide would be a fine idea.

RowboTony commented

All good, I mostly had to brush up on markdown syntax. I'm satisfied with the markup, and the blog post has been submitted as a PR. Thanks!