Skip to content
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

Typographic quotation marks & shell-sessions #37

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

toastal
Copy link

@toastal toastal commented Mar 11, 2022

  • Move to typographically-correct apostrophes and quotation marks
  • The sh blocks were not for shell scripts, instead they are shell-sessions, things to run in your terminal emulator
  • PR to pull request as it is easier to understand

Suggestion: change to AsciiDoc/reStructuredText to get features you are emulating

  • images can have dimensions (replaces the first line needing HTML)
  • Definition lists are used (key-value lists), but instead Markdown bold is used

If the suggestion is liked, I would gladly convert the document instead of this merge request.

* Move to typographically-correct apostrophes and quotation marks
* The `sh` blocks were not for shell scripts, instead they are `shell-sessions`, things to run in your terminal emulator
* PR to pull request as it is easier to understand

---

Suggestion: change to AsciiDoc to get features you are emulating
* images can have dimensions (replaces the first line needing HTML)
* Definition lists are used (key-value lists), but instead Markdown bold is used
* No need to use headings for titles for code block; some of these aren't document sections but just a description of the code block
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