search

lukeorth / poison

Professional Hugo theme for dev bloggers. Based on Mdo's classic Hyde theme.
https://poison.lukeorth.com
GNU General Public License v3.0
205 stars 97 forks source link

Update README.md code block examples. #72

Closed catay closed 1 year ago

catay commented 1 year ago

Putting the / / in the code block examples might be confusing for end-users. This only applies if you want to use example code blocks with short codes as content in Hugo, not GitHub Flavored markdown.

lukeorth commented 1 year ago

Thank you, @catay -- I completely agree. I had initially written it the way you're suggesting. However, for some reason, even though my shortcode examples are nested within markdown code blocks, the hugoThemeSiteBuilder repo was having issues deploying the README (here's my latest PR with the issues). They removed my theme from the Hugo Themes site because of it.

So while I completely agree with you and appreciate your contribution, I unfortunately can't merge it since it'll cause my theme to be removed again. :pensive:

catay commented 1 year ago

Thanks @lukeorth , ok wasn't aware of this.

Maybe you can do something like what they do here: https://themes.gohugo.io/themes/hugo-theme-relearn/ They point to the demo site to show examples of diagrams.

lukeorth commented 1 year ago

That's fair - I hadn't thought about doing that. That's a good workaround.

I just updated the README and demo site. Let me know if you see anything that you think should be changed.

Thanks again for the help!