chore: reformat markdown with prettier #2114

B4nan · 2025-11-25T16:14:34Z

Using npx prettier --print-width 100 --write "sources/**/*.md" to format the code, before merging, I'll add it to the NPM scripts and add a CI check to ensure formatting is correct, right now the PR only contains content changes.

Note

Applies a repository-wide Prettier-style markdown reformat (frontmatter, code blocks, lists, tables, links, and escapes) with no content changes.

Docs (Markdown formatting pass):
- Standardizes frontmatter quotes, escapes, and imports (e.g., ../scraping_basics/_exercises.mdx → ../scraping_basics/\_exercises.mdx).
- Normalizes code fences, JSON/JS examples, indentation, and inline formatting (emphasis, backticks).
- Cleans up lists, tables, and tip/admonition blocks; fixes link/table syntax and spacing.
- Harmonizes headings, bullets, and block spacing; minor typo/whitespace tweaks.
- No content or functional changes—formatting only.

^{Written by Cursor Bugbot for commit 9b7e61c. Configure here.}

apify-service-account · 2025-11-25T16:17:41Z

Preview for this PR was built for commit 9b7e61c and is ready at https://pr-2114.preview.docs.apify.com!

apify-service-account · 2025-11-25T16:20:52Z

Preview for this PR was built for commit 9430a74 and is ready at https://pr-2114.preview.docs.apify.com!

apify-service-account · 2025-11-26T15:20:48Z

Preview for this PR was built for commit 6f5fac08 and is ready at https://pr-2114.preview.docs.apify.com!

apify-service-account · 2025-11-26T15:24:36Z

Preview for this PR was built for commit 647c54ed and is ready at https://pr-2114.preview.docs.apify.com!

apify-service-account · 2025-11-26T15:28:20Z

Preview for this PR was built for commit 24239be6 and is ready at https://pr-2114.preview.docs.apify.com!

B4nan · 2025-11-26T15:39:52Z

For anyone trying to review this, be sure to disable diffs on whitespaces

apify-service-account · 2025-11-26T16:42:04Z

Preview for this PR was built for commit 9abf66d4 and is ready at https://pr-2114.preview.docs.apify.com!

TC-MO

It unified few things in docs that we were looking to fix either.
Not a fan of bloated and unreadable tables in raw .md

We should remove /legal from linting and not sure if we should revert the changes? We already ignore it with markdownlint and vale

Other than that LGTM

TC-MO · 2025-11-26T18:24:40Z

sources/academy/build-and-publish/actor-ideas/what_software_an_actor_can_be.md

 :::

 1. _Visit_ [apify.com/ideas](https://apify.com/ideas) to find ideas that interest you. Look for ideas that align with your skills.
+2. _Select an Actor idea_: Review the details and requirements. Check the status—if it's marked **Open to develop**, you can start building.


I'd rather keep only 1. as ordered lists. It makes for much easier maitenance

to me, having only 1. everywhere is a hack, not a proper solution. it produces warnings in webstorm, and i am actually surprised it doesnt trigger linter errors.

this is a job for IDE, you shouldn't do that by hand. not sure if vscode doesnt have a helper, webstorm does.

It's not a hack, this is based on CommonMark spec which Docusaurus supports. Either way in VSC/Cursor this is handled by extension, I was curious that here I saw it changed to regular numbering but not in other cases

TC-MO · 2025-11-26T18:27:22Z

sources/academy/build-and-publish/how-to-build/running_a_web_server.md

-    APIFY_CONTAINER_URL,
-    APIFY_DEFAULT_KEY_VALUE_STORE_ID,
-} = process.env;
+const { APIFY_CONTAINER_PORT, APIFY_CONTAINER_URL, APIFY_DEFAULT_KEY_VALUE_STORE_ID } = process.env;


I have no opinion about this tbh, not sure what is the better dev experience here?

we dont really have control over this (we can only set max line length). afaik we cant disable formatting of code blocks.

sidenote: i really dislike we are using destructuring of env vars in the first place, this is an antipattern to me, since changing their values after the program started won't have any effect on the code.

TC-MO · 2025-11-26T18:32:48Z

sources/academy/webscraping/scraping_basics_javascript/01_devtools_inspecting.md

 ---
 title: Inspecting web pages with browser DevTools
-sidebar_label: "DevTools: Inspecting"
+sidebar_label: 'DevTools: Inspecting'


I think neither ' nor " is needed in front matter

quotes are needed if the value contains colon

TC-MO · 2025-11-26T18:38:15Z

sources/academy/webscraping/scraping_basics_legacy/crawling/headless_browser.md

 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
-import LegacyAdmonition from '../../scraping_basics/_legacy.mdx';
+import LegacyAdmonition from '../../scraping_basics/\_legacy.mdx';


I assume this won't break the import?

it would break the CI if that would be the case

B4nan · 2025-11-27T16:38:57Z

Not a fan of bloated and unreadable tables in raw .md

Well, this was the exact reason for reformatting the markdown, to fix table formatting. I am on the opposite side, I am not a fan of what we had before, it's nearly impossible to see what columns should correspond.

TC-MO · 2025-11-28T00:03:57Z

True, true, just not a fan of it :D

B4nan requested review from TC-MO, honzajavorek and mnmkng as code owners November 25, 2025 16:14

github-actions bot assigned B4nan Nov 25, 2025

github-actions bot added this to the 128th sprint - Tooling team milestone Nov 25, 2025

github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Nov 25, 2025

B4nan force-pushed the reformat-markdown branch from 9b7e61c to 9430a74 Compare November 25, 2025 16:16

B4nan force-pushed the reformat-markdown branch 2 times, most recently from 0c33747 to c35afb7 Compare November 26, 2025 15:04

chore: reformat markdown with prettier

2695567

B4nan force-pushed the reformat-markdown branch from c35afb7 to 2695567 Compare November 26, 2025 15:10

B4nan added the adhoc Ad-hoc unplanned task added during the sprint. label Nov 26, 2025

Merge branch 'master' into reformat-markdown

6f5fac0

B4nan added 2 commits November 26, 2025 16:21

fix vale

647c54e

spacing

24239be

nits

9abf66d

TC-MO approved these changes Nov 26, 2025

View reviewed changes

chore: reformat markdown with prettier #2114

Are you sure you want to change the base?

chore: reformat markdown with prettier #2114

Uh oh!

Conversation

B4nan commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

apify-service-account commented Nov 25, 2025

Uh oh!

apify-service-account commented Nov 25, 2025

Uh oh!

apify-service-account commented Nov 26, 2025

Uh oh!

apify-service-account commented Nov 26, 2025

Uh oh!

apify-service-account commented Nov 26, 2025

Uh oh!

B4nan commented Nov 26, 2025

Uh oh!

apify-service-account commented Nov 26, 2025

Uh oh!

TC-MO left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

B4nan commented Nov 27, 2025

Uh oh!

TC-MO commented Nov 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

B4nan commented Nov 25, 2025 •

edited

Loading

TC-MO left a comment •

edited

Loading