chore: reformat markdown with prettier#2114
Conversation
github-actions
Bot
added
the
t-tooling
B4nan
force-pushed
the
reformat-markdown
branch
from
9b7e61c to
9430a74
Compare
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
B4nan
force-pushed
the
reformat-markdown
branch
2 times, most recently
from
0c33747 to
c35afb7
Compare
B4nan
force-pushed
the
reformat-markdown
branch
from
c35afb7 to
2695567
Compare
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
For anyone trying to review this, be sure to disable diffs on whitespaces 
|
|
Preview for this PR was built for commit |
There was a problem hiding this comment.
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
| ::: | ||
|
|
||
| 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. |
There was a problem hiding this comment.
I'd rather keep only 1. as ordered lists. It makes for much easier maitenance
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
| 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; |
There was a problem hiding this comment.
I have no opinion about this tbh, not sure what is the better dev experience here?
There was a problem hiding this comment.
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.
| --- | ||
| title: Inspecting web pages with browser DevTools | ||
| sidebar_label: "DevTools: Inspecting" | ||
| sidebar_label: 'DevTools: Inspecting' |
There was a problem hiding this comment.
I think neither ' nor " is needed in front matter
There was a problem hiding this comment.
quotes are needed if the value contains colon
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
| import LegacyAdmonition from '../../scraping_basics/_legacy.mdx'; | ||
| import LegacyAdmonition from '../../scraping_basics/\_legacy.mdx'; |
There was a problem hiding this comment.
I assume this won't break the import?
There was a problem hiding this comment.
it would break the CI if that would be the case
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. |
|
True, true, just not a fan of it :D |
4 participants
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.
../scraping_basics/_exercises.mdx→../scraping_basics/\_exercises.mdx).Written by Cursor Bugbot for commit 9b7e61c. Configure here.