New highlight.js website! Help us test it 😄 #3611

allejo · 2022-09-08T02:39:53Z

Hello everyone! I'm by no means someone you see hanging out in this repo often; I stop by whenever code reviews are needed or a second opinion is wanted. Something I've been working on for months now (on and off) is a new website for our beloved syntax highlighting library 🥳

Our new website is powered by Next.js and is generously hosted by ~~Heroku~~ Netlify (for now). We need your help testing the new website, giving us feedback, reporting bugs, etc.

I've tried my best to meet feature parity with the current website, reorganizing some pages, and adding a much-requested demo page!

Website: https://highlightjs.org/ (aka, https://hljs.netlify.app)
GitHub repository: https://github.com/highlightjs/highlightjs.org
Report issues here: https://github.com/highlightjs/highlightjs.org/issues

Ideally, we'd like to go live with the new website towards the end of September, early October.

Administrative Tasklist

Switch DNS for https://highlightjs.org/ to point to Heroku
Build Github Workflows for new highlight.js releases to trigger a new website build

/cc @highlightjs/core

The text was updated successfully, but these errors were encountered:

taufik-nurrohman · 2022-09-08T04:34:17Z

FYI, the language pack generator feature is very useful. Wish there will be a public API that I could use to generate my own language set through my application. An API URL that simply return a plain text response that I could save as highlight.js for example.

allejo · 2022-09-08T06:41:39Z

FYI, the language pack generator feature is very useful. Wish there will be a public API that I could use to generate my own language set through my application. An API URL that simply return a plain text response that I could save as highlight.js for example.

Underneath the new /download page lives an undocumented (as of this moment) /api/download endpoint that accepts POST requests (watch your browser's Network tab) with a JSON body in the structure of,

{
  "api": 2,
  "languages": []
}

This API endpoint returns an attachment response with the bundled zip file. I'm open to considering adding an endpoint that returns just the JS and not the entire zip.

joshgoebel · 2022-09-08T14:11:04Z

I'd suggest perhaps a format: [zip,javascript] choice perhaps?

joshgoebel · 2022-09-08T15:30:27Z

Some indication that "Docs" and "GitHub" were going to jump you to another site might be nice... I always frown when I see links in "sitewide navigation" that link to entirely different sites without any warning. Maybe move them to right with a | inbetween with a diff color/shade?

joshgoebel · 2022-09-08T15:52:58Z

Does VS Code use us directly or just in plugins? If we're not in the default install I think that's a little deceptive and we should remove them from the list and find another big site.

isagalaev · 2022-09-08T18:27:44Z

This looks really nice :-) Glad you kept the color scheme!

joshgoebel · 2022-09-08T21:38:37Z

This looks really nice

Yes, it looks amazing.

I totally should have led with that before jumping into my [overall] minor nitpicks... I'd be fine launching it just as soon as we hook up the Github actions to deal with new releases... and of course we can continue to improve post-launch as well... or I'm also ok with the plan to test a bit longer (or wait for more feedback), then launch.

@allejo Were you planning to help setup the GH actions also? I think some of the work we've already done with auto-publishing the cdn-release gem might be relevant? I imagine we're talking two parts:

GH action here pushes to Heroku on now commits, etc
GH release on main repo updates this repo's "source" files? (or bumps a version or something)

I haven't looked too deeply into the programming here yet.

allejo · 2022-09-09T01:35:21Z

Does VS Code use us directly or just in plugins? If we're not in the default install I think that's a little deceptive and we should remove them from the list and find another big site.

That's true 🤔 As far as I know, VSC uses hljs for syntax highlighting of markdown code blocks in previews. I'd welcome any other websites/services that use us to replace VSC!

Were you planning to help setup the GH actions also? I think some of the work we've already done with auto-publishing the cdn-release gem might be relevant?

Yes! I'll be looking into the GitHub actions for syncing releases. I think there will definitely be shared logic between these actions

GH action here pushes to Heroku on now commits, etc

Heroku provides a GitHub app that syncs stuff for us, this is already taken care of 🥳

GH release on main repo updates this repo's "source" files? (or bumps a version or something)

Correct, it'd bump the package.json file in the website's repo to the latest release and rebuild everything from there.

joshgoebel · 2022-09-09T20:48:08Z

https://github.com/highlightjs/highlight.js/blob/main/.github/workflows/release.yml#L82

This is where the relevant part starts...

ghost · 2022-09-18T21:58:12Z

Hi all. great website :)

Hirse · 2022-10-18T03:38:49Z

As someone who's in the past contributed to the (old? current?) website, the new one is looking nice!

A few things I noticed:

different favicon, is that intentionally?
Links to Docs and GitHub not opening in new tab
Add link to npm?
Update default theme (or add new default-dark) to use on the website?
"News" -> "Releases"?
I like the design of the news, but it doesn't really match the rest of the page
Why is "Code Samples" such a tiny link in the bottom?

Happy to contribute for the above. 😄

ghost · 2022-10-18T19:44:36Z

Hi all.

Please update the repository readme link.

before

after

adsingh14 · 2022-10-25T05:00:36Z

Good to see this! I've noticed one bug,

Visit https://highlightjs-web.herokuapp.com/download
Type 'test'

It'll show blank box

Again type 'html'. That blank box will stay there (stick with the header)

AdamRaichu · 2023-01-05T22:35:55Z

As of right now, https://highlightjs-web.herokuapp.com is not working.

allejo · 2023-07-21T04:30:23Z

As of right now, https://highlightjs-web.herokuapp.com is not working.

Life really got in the way with my commitments, especially to this project... I will be working on the logistics of migrating the site over the next week or so 🤞

The website demo can now be found at: https://hljs.netlify.app

I would really appreciate any help testing and finding bugs!

jf990 · 2023-07-22T16:15:03Z

@allejo I did some ad-hoc testing and everything looks great to me, really nice work. The only issue I ran into was the download, even though I selected a small subset of languages, my download contained what looked like all languages.

allejo · 2023-08-02T01:38:47Z

Some indication that "Docs" and "GitHub" were going to jump you to another site might be nice... I always frown when I see links in "sitewide navigation" that link to entirely different sites without any warning. Maybe move them to right with a | inbetween with a diff color/shade?

Fixed in highlightjs/highlightjs.org@6e088db

The only issue I ran into was the download, even though I selected a small subset of languages, my download contained what looked like all languages.

Fixed in highlightjs/highlightjs.org@ebf0ac5

allejo · 2023-08-02T02:24:53Z

different favicon, is that intentionally?

not intentional! I always forget about favicons 🤦‍♂️ fixed in highlightjs/highlightjs.org@9e225ea

Links to Docs and GitHub not opening in new tab

fixed in highlightjs/highlightjs.org@93e1acb

Add link to npm?

Ahh good call! I'll update the Usage section with a bit more information from our README in a bit.

Update default theme (or add new default-dark) to use on the website?

Lemme loop @joshgoebel into this question. I think we have enough themes already so I don't think we want to add more. Are you talking about using another theme instead of the one I'm using right now?

"News" -> "Releases"?

I'm going to leave this as news, so that we can use that area of the site to post announcements (e.g. the news article about a new website)

I like the design of the news, but it doesn't really match the rest of the page

Now the Downloads page and the News page share the same blurred dark background! I hope this makes it have a more consistent feel

Why is "Code Samples" such a tiny link in the bottom?

Because I couldn't figure out a way to stuff it in the top nav bar without cluttering it... 😓 I'm open to design ideas!

allejo · 2023-08-02T02:30:51Z

After some quick DNS struggles, our new website is live! 🥳 🎉

Moving forward, please report any new bugs at the highlightjs/highlightjs.org repo.

isagalaev · 2023-08-02T02:59:44Z

Congrats, folks!

mdr1384 · 2023-08-15T16:13:06Z

The download page gives you a ZIP file with absolute paths in it... rendering it unusable on FreeBSD (since they have a really old unzip)...

$ /usr/bin/unzip -l highlight.zip | head
Archive:  highlight.zip
  Length     Date   Time    Name
 --------    ----   ----    ----
    38854  08-10-23 22:10   /DIGESTS.md
     1514  08-10-23 22:10   /LICENSE
     1717  08-10-23 22:10   /README.md
        0  08-10-23 22:10   /es/
    76121  08-10-23 22:10   /es/core.js
    20322  08-10-23 22:10   /es/core.min.js
    76121  08-10-23 22:10   /es/highlight.js

$ unzip highlight.zip
Archive:  highlight.zip
unzip: skipping insecure entry '/DIGESTS.md'
unzip: skipping insecure entry '/LICENSE'
unzip: skipping insecure entry '/README.md'
unzip: skipping insecure entry '/es'
...

allejo · 2023-08-25T18:58:27Z

The download page gives you a ZIP file with absolute paths in it... rendering it unusable on FreeBSD (since they have a really old unzip)...

@mdr1384 thanks for your report! This was reported in #3835 and has been fixed in production 😄

wil93 · 2023-09-12T12:16:40Z

FYI the demo page is currently detecting everything as Delphi

allejo · 2023-09-19T19:17:00Z

FYI the demo page is currently detecting everything as Delphi

Thank you for the report, this is being tracked over at highlightjs/highlightjs.org#7. It's a weird quirk with the way the final website is bundled for production.

allejo added help welcome Could use help from community big picture Policy or high level discussion labels Sep 8, 2022

allejo pinned this issue Sep 8, 2022

allejo mentioned this issue Sep 9, 2022

Split up navigation links between internal and external links highlightjs/highlightjs.org#3

Closed

joshgoebel mentioned this issue Oct 25, 2022

[UI/UX] Dropdown for language and style. #3640

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New highlight.js website! Help us test it 😄 #3611

New highlight.js website! Help us test it 😄 #3611

allejo commented Sep 8, 2022 •

edited

taufik-nurrohman commented Sep 8, 2022

allejo commented Sep 8, 2022

joshgoebel commented Sep 8, 2022

joshgoebel commented Sep 8, 2022

joshgoebel commented Sep 8, 2022

isagalaev commented Sep 8, 2022

joshgoebel commented Sep 8, 2022 •

edited

allejo commented Sep 9, 2022

joshgoebel commented Sep 9, 2022

ghost commented Sep 18, 2022 •

edited by ghost

Hirse commented Oct 18, 2022

ghost commented Oct 18, 2022 •

edited by ghost

adsingh14 commented Oct 25, 2022

AdamRaichu commented Jan 5, 2023

allejo commented Jul 21, 2023

jf990 commented Jul 22, 2023

allejo commented Aug 2, 2023 •

edited

allejo commented Aug 2, 2023

allejo commented Aug 2, 2023

isagalaev commented Aug 2, 2023

mdr1384 commented Aug 15, 2023

allejo commented Aug 25, 2023

wil93 commented Sep 12, 2023

allejo commented Sep 19, 2023

New highlight.js website! Help us test it 😄 #3611

New highlight.js website! Help us test it 😄 #3611

Comments

allejo commented Sep 8, 2022 • edited

Administrative Tasklist

taufik-nurrohman commented Sep 8, 2022

allejo commented Sep 8, 2022

joshgoebel commented Sep 8, 2022

joshgoebel commented Sep 8, 2022

joshgoebel commented Sep 8, 2022

isagalaev commented Sep 8, 2022

joshgoebel commented Sep 8, 2022 • edited

Yes, it looks amazing.

allejo commented Sep 9, 2022

joshgoebel commented Sep 9, 2022

ghost commented Sep 18, 2022 • edited by ghost

Hirse commented Oct 18, 2022

ghost commented Oct 18, 2022 • edited by ghost

adsingh14 commented Oct 25, 2022

AdamRaichu commented Jan 5, 2023

allejo commented Jul 21, 2023

jf990 commented Jul 22, 2023

allejo commented Aug 2, 2023 • edited

allejo commented Aug 2, 2023

allejo commented Aug 2, 2023

isagalaev commented Aug 2, 2023

mdr1384 commented Aug 15, 2023

allejo commented Aug 25, 2023

wil93 commented Sep 12, 2023

allejo commented Sep 19, 2023

allejo commented Sep 8, 2022 •

edited

joshgoebel commented Sep 8, 2022 •

edited

ghost commented Sep 18, 2022 •

edited by ghost

ghost commented Oct 18, 2022 •

edited by ghost

allejo commented Aug 2, 2023 •

edited