Skip to content

Commit b07b3a4

Browse files
committed
blog contribution checklist
1 parent 2f9d417 commit b07b3a4

4 files changed

Lines changed: 103 additions & 73 deletions

File tree

docs/getting_started.md

Lines changed: 42 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -306,16 +306,27 @@ Key Features of GitLab:
306306
Plain Markdown tables are left-aligned by default in Docusaurus. Wrap your table in an `:::info` block to center it:
307307

308308
```md
309-
:::info
309+
:::
310310
311-
| Command | Description |
312-
|---------|----------------------|
313-
| `git init` | Initialize a repo |
314-
| `git clone` | Clone a repo |
311+
| Command | Description |
312+
|-------------|-------------------|
313+
| `git init` | Initialize a repo |
314+
| `git clone` | Clone a repo |
315315

316316
:::
317317
```
318318
319+
### Rendered Output
320+
321+
:::info
322+
323+
| Command | Description |
324+
|-------------|-------------------|
325+
| `git init` | Initialize a repo |
326+
| `git clone` | Clone a repo |
327+
328+
:::
329+
319330
---
320331

321332
#### FAQ Section (Required)
@@ -434,11 +445,11 @@ git push origin blog/your-blog-title
434445

435446
## Step 12: Open a Pull Request
436447

437-
1. Go to your fork on GitHub — you will see a **"Compare & pull request"** banner. Click it.
438-
2. Set the **base repository** to `recodehive/recode-website` and **base branch** to `main`.
439-
3. Write a clear PR title, e.g. `blog: Add post on Your Blog Title`.
440-
4. In the description, briefly summarize what the post covers.
441-
5. Click **Create pull request**.
448+
- 1. Go to your fork on GitHub — you will see a **"Compare & pull request"** banner. Click it.
449+
- 2. Set the **base repository** to `recodehive/recode-website` and **base branch** to `main`.
450+
- 3. Write a clear PR title, e.g. `blog: Add post on Your Blog Title`.
451+
- 4. In the description, briefly summarize what the post covers.
452+
- 5. Click **Create pull request**.
442453

443454
A maintainer will review and merge your post. You may be asked to make small edits before it is approved.
444455

@@ -461,24 +472,24 @@ git push origin main
461472

462473
Before submitting your PR, go through this checklist:
463474

464-
- [ ] Blog folder created at `blog/your-blog-title/index.md`
465-
- [ ] Frontmatter is complete (title, authors, tags, date, description, draft: false)
466-
- [ ] Author entry exists in `blog/authors.yml`
467-
- [ ] `<!-- truncate -->` comment placed after the intro paragraph
468-
- [ ] **Bulleted summary section** included near the top of the post
469-
- [ ] **FAQ section** included at the bottom of the post
470-
- [ ] No generic content — article is high-depth and technical with images
471-
- [ ] 5 external backlinks to supporting websites
472-
- [ ] 5 internal backlinks to other recodehive articles
473-
- [ ] Text is more than code — long code blocks link to GitHub instead
474-
- [ ] Code blocks use filename labels — e.g., opening fence followed by `python title="app.py"`
475-
- [ ] Query + output pairs use Tabs blocks
476-
- [ ] Tables are wrapped in `:::info` for center alignment
477-
- [ ] Tips, notes, and cautions use the correct Docusaurus admonition
478-
- [ ] All images are in `blog/your-blog-title/images/` with SEO-friendly names
479-
- [ ] Cover image is 1200 × 630 px; step screenshots are no wider than 1280 px
480-
- [ ] Image file sizes are under 500 KB each
481-
- [ ] Post previews correctly at `localhost:3000/blog`
482-
- [ ] Database entry added in `\database\blogs\index.tsx`
483-
- [ ] Committed on a feature branch (not `main`)
484-
- [ ] Pull request targets `recodehive/recode-website` `main` branch
475+
- 1. [ ] Blog folder created at `blog/your-blog-title/index.md`
476+
- 2. [ ] Frontmatter is complete (title, authors, tags, date, description, draft: false)
477+
- 3. [ ] Author entry exists in `blog/authors.yml`
478+
- 4. [ ] `<!-- truncate -->` comment placed after the intro paragraph
479+
- 5. [ ] **Bulleted summary section** included near the top of the post
480+
- 6. [ ] **FAQ section** included at the bottom of the post
481+
- 7. [ ] No generic content — article is high-depth and technical with images
482+
- 8. [ ] 5 external backlinks to supporting websites
483+
- 9. [ ] 5 internal backlinks to other recodehive articles
484+
- 10. [ ] Text is more than code — long code blocks link to GitHub instead
485+
- 11. [ ] Code blocks use filename labels — e.g., opening fence followed by `python title="app.py"`
486+
- 12. [ ] Query + output pairs use Tabs blocks
487+
- 14. [ ] Tables are wrapped in `:::info` for center alignment
488+
- 15. [ ] Tips, notes, and cautions use the correct Docusaurus admonition
489+
- 16. [ ] All images are in `blog/your-blog-title/images/` with SEO-friendly names
490+
- 17. [ ] Cover image is 1200 × 630 px; step screenshots are no wider than 1280 px
491+
- 18. [ ] Image file sizes are under 500 KB each
492+
- 19. [ ] Post previews correctly at `localhost:3000/blog`
493+
- 20. [ ] Database entry added in `\database\blogs\index.tsx`
494+
- 21. [ ] Committed on a feature branch (not `main`)
495+
- 22. [ ] Pull request targets `recodehive/recode-website` `main` branch

docusaurus.config.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ const config: Config = {
3838

3939
onBrokenLinks: "throw",
4040
// onBrokenMarkdownLinks moved to markdown.hooks
41-
41+
4242
// Google Analytics and Theme Scripts
4343
scripts: [
4444
{
@@ -298,10 +298,10 @@ const config: Config = {
298298
EMAILJS_TEMPLATE_ID: process.env.EMAILJS_TEMPLATE_ID || "",
299299
algoliaSiteSearch: hasAlgoliaSiteSearch
300300
? {
301-
applicationId: algoliaAppId,
302-
apiKey: algoliaSearchApiKey,
303-
indexName: algoliaIndexName,
304-
}
301+
applicationId: algoliaAppId,
302+
apiKey: algoliaSearchApiKey,
303+
indexName: algoliaIndexName,
304+
}
305305
: null,
306306
hooks: {
307307
onBrokenMarkdownLinks: "warn",

package-lock.json

Lines changed: 53 additions & 35 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
"react-icons": "^5.5.0",
6565
"react-slot-counter": "^3.3.1",
6666
"rehype-katex": "^7.0.1",
67+
"remark-gfm": "^4.0.1",
6768
"remark-math": "^6.0.0",
6869
"styled-components": "^6.4.1",
6970
"tailwind-merge": "^3.6.0",
@@ -84,7 +85,7 @@
8485
"eslint": "^9.38.0",
8586
"eslint-plugin-react": "^7.37.5",
8687
"husky": "^9.1.7",
87-
"lint-staged": "^17.0.4",
88+
"lint-staged": "^16.0.0",
8889
"postcss": "^8.5.14",
8990
"prettier": "^3.8.3",
9091
"prettier-plugin-tailwindcss": "^0.6.14",
@@ -106,4 +107,4 @@
106107
"engines": {
107108
"node": ">=18.0"
108109
}
109-
}
110+
}

0 commit comments

Comments
 (0)