Skip to content

Commit 170bff0

Browse files
authored
Merge pull request #1174 from openmina/dw/markdown-format
Introduce common formatting practices for Markdown files
2 parents 4ed0363 + 75d66c0 commit 170bff0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+2221
-1432
lines changed

.github/workflows/markdown-format.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Markdown Format Check
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
8+
jobs:
9+
markdown-format:
10+
name: Check Markdown Formatting
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v4
15+
16+
- name: Setup Node.js
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: '20'
20+
cache: 'npm'
21+
22+
- name: Install dependencies
23+
run: npm install
24+
25+
- name: Check markdown formatting
26+
run: make check-md

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
/node/testing/res/
33
.DS_Store
44
*.profraw
5+
node_modules

.prettierignore

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Dependencies
2+
node_modules/
3+
**/node_modules/
4+
5+
# Build outputs
6+
target/
7+
**/target/
8+
dist/
9+
build/
10+
11+
# Generated files
12+
**/*.generated.md
13+
**/*.lock
14+
15+
# Frontend specific
16+
frontend/src/assets/
17+
frontend/public/
18+
frontend/dist/
19+
20+
# Test files
21+
**/test-output/
22+
**/coverage/
23+
24+
# Docker
25+
Dockerfile*
26+
docker-compose*.yml
27+
28+
# Cargo.toml and other config files
29+
*.toml
30+
*.lock
31+
*.log
32+
33+
# Binary files
34+
*.bin
35+
*.wasm
36+
*.so
37+
*.dylib
38+
39+
# Documentation that should not be auto-formatted
40+
CHANGELOG.md

0 commit comments

Comments
 (0)