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.

Sign up for GitHub

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

fix: correct Markdown header syntax #2

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

fix: correct Markdown header syntax #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Simple-indexer requires PostgreSQL as a backend database and [TypeORM](https://g

# How to run

### Developement
### Development
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix heading hierarchy in the README

The current heading structure is inconsistent. The document jumps from h1 ("How to run") directly to h3 ("Development"), skipping the h2 level. This violates Markdown heading hierarchy best practices.

Apply this diff to fix the heading structure:

-### Development
+## Development

Additionally, consider applying the same change to other h3 headings under main sections for consistency:

  • Under "Project setup": Change 1-4 to h2
  • Under "How to run": Change "Production" to h2

This would create a more logical and consistent document structure:

# Main Section (h1)
## Sub Section (h2)
### Sub-sub Section (h3)
🧰 Tools
🪛 Markdownlint (0.35.0)

38-38: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)


```bash
npm run dev
Expand Down