Skip to content
This repository has been archived by the owner on May 10, 2023. It is now read-only.

Fix tutorial typos and improve styling #112

Merged
merged 1 commit into from
Feb 15, 2022

Conversation

alejandromumo
Copy link
Member

Fixed typos in tutorial's README.

Improved styling following markdown linting rules using markdownlint, as suggested in #83 . Namely:

  • Fixed indentation for code blocks and text inside a list's item. Apart from being unsightly in the rendered markdown, also triggered linting's rule md029.
  • Fixed commandline vs bash vs console inconsistencies in code-blocks containing shell commands. For instance:
    • Replaced commandline with console whenever the written command contains prompts. E.g:
      john@doe:~$ ls -la
      foo bar
      Instead, if using bash it would render as:
      john@doe:~$ ls -la
      foo bar
      Otherwise, bash can be used.
    • bash with or without $. Added $ before a command with output, removed it otherwise following linting rule md014.
  • Fixed trailing spaces md009 and EOF spaces md047
  • Fixed blank lines surrounding headers, following rule md022

@slint slint merged commit 9fc4be0 into inveniosoftware:master Feb 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants