Skip to content
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

Merged
merged 7 commits into from Aug 11, 2023
Merged

docs: update docs #2928

merged 7 commits into from Aug 11, 2023

Conversation

UziTech
Copy link
Member

@UziTech UziTech commented Aug 9, 2023

Description

Update docs

  • Update highlight js css
  • Use markedHighlight extension
  • Add Instance link
  • Fix headers with headerIds: false
  • Import esm version in worker
  • Remove unfetch and ESPromise dependencies
  • Remove non-worker demo parser
  • Animate response time when markdown updates

Contributor

  • Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

@UziTech UziTech added the category: docs Documentation changes label Aug 9, 2023
@vercel
Copy link

vercel bot commented Aug 9, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
marked-website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 11, 2023 3:23am

@calculuschild
Copy link
Contributor

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!".

@UziTech
Copy link
Member Author

UziTech commented Aug 10, 2023

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);
Copy link
Member

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>
Copy link
Member

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?

Copy link
Member Author

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.

docs/demo/worker.js Outdated Show resolved Hide resolved
Copy link
Member

@styfle styfle left a 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>
@UziTech UziTech merged commit 71cc7b9 into markedjs:master Aug 11, 2023
12 checks passed
@UziTech UziTech deleted the docs branch August 26, 2023 03:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants