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.
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
docs: update docs #2928
docs: update docs #2928
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Looks fine to me. Only comment is the response time seems to be way off. I.e., if I paste in a huge block, the output panel will time out saying (took longer than 1 second... 2 seconds.... 3 seconds) and eventually render, then the Response Time happily animates to say "177ms!". |
The response time is the time it took marked to parse the markdown. The time it takes to send the payload to and from the worker is not included. |
@@ -38,14 +45,7 @@ async function build(currentDir, tmpl) { | |||
let buffer = await readFile(filename); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should add utf8
here to work with the string instead of the buffer..
That can be a future PR 😄
@@ -10,14 +10,14 @@ | |||
- [ ] Run `npm run build:reset` to remove changes to compiled files. | |||
- [ ] Submit a Pull Request. | |||
|
|||
## Design principles | |||
<h2 id="design-principles">Design principles</h2> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we enable header ids instead of doing this manually?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are already doing it manually in most of our pages so the ids don't get too long. I think we should keep it consistent and we don't want to change it for existing ids otherwise urls will break.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like this will drop support for IE but I think that ship sailed a long time ago once we bumped the minimum Node.js version to 16.
LGTM 👍
Co-authored-by: Steven <steven@ceriously.com>
Description
Update docs
Contributor
Committer
In most cases, this should be a different person than the contributor.