Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Use 2 spaces instead of 4 spaces (or tabs) in *.md

Open
#25 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
30/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Stale
Tech stack
markdown
Domain
tooling

Research direction

Inspect the repository's .editorconfig file and compare its general indentation settings with the Markdown-specific example in the issue. Done means the configuration includes a *.md section using spaces with an indent size of 2.

Written by the indexing model from the issue text.

Description

discussion documentation

If you use Spaces — 2, you can indent lists:

image

However, if you try and do the same thing with Tabs — 2 or 4, indenting always results in code formatting:

image

So, 2 spaces gives the most flexibility, because you can do:


  • list item
  • another

AND:

- list item in code format
- another in code format

Like that:


  - list item
  - another

AND:

    - list item in code format
    - another in code format

This means .editorconfigs like this should look more like:

; Unix-style newlines
[*]
end_of_line = LF
indent_style = tab
indent_size = 4

[{*.json,*.yml,*.md}]
indent_style = space
indent_size = 2

(notice addition of *.md)

Dominant language
JavaScript
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from donejs/developer-relations

All issues in donejs/developer-relations

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.