search

co-analysis / govukhugo

GOV.UK style theme for Hugo site builder
https://co-analysis.github.io/govuk-hugo-demo
MIT License
14 stars 2 forks source link

Installation #7

Closed winstonford closed 2 years ago

winstonford commented 2 years ago

Regarding:

$ git submodule add https://github.com/co-analysis/govuk-hugo.git themes/govukhugo

Consider:

git submodule add https://github.com/co-analysis/govuk-hugo themes/govukhugo

As: The $ throws an error when pasted into terminal, and the .git is not needed

mattkerlogue commented 2 years ago

Hi, thank you for your feedback. The use of the $ is to signify that it is a syntax to enter into a command line shell, rather than script based code. This is a common convention for command line documentation, as it mimics the use of the dollar sign as the end of the default UNIX prompt. For example it is recommended by both Google and WordPress in their style guides on how to write documentation relating to the command line.

winstonford commented 2 years ago

Interesting. Thanks for the links. Agree with the style. But in this case, the style breaks the functionality.. or requires that one delete the usefully stylistic $ before hitting return running the pasted command. What would be ideal is if the $ was outside the code fence, or somehow not copied. I will play around with that idea in md and report back if I figure out a way.