Polish https://pod6.in/

zag / js-pod6

Pod6 is an easy-to-use markup language. It can be used for writing language documentation, for documenting programs and modules, as well as for other types of document composition

https://pod6.in

MIT License

9 stars 0 forks source link

Polish https://pod6.in/ #13

Open patrickbkr opened 4 years ago

patrickbkr commented 4 years ago

I think an online Pod6 editor is a brilliant idea and has the potential to promote Pod6 a lot because of its approachability. (Opening a website has the lowest barrier of entry one can possibly have.) So this issue is mostly an encouragement to polish the https://pod6.in/ website more.

Here are just some ideas of what could be done:

Give it a logo and a shiny page header
Add an "About" button
Link to the repo with a GitHub icon
Add a link to https://docs.raku.org/language/pod
Add a basic syntax documentation on the page itself
Do some SEO so it pops up at the top when googling "pod6 editor" and "pod6 editor online"
Add more expressive HTML highlighting (in the right column). Compare the a docs page with viewing the pod in pod6.in
Add some POD highlighting (in the left column).
Persist edited content (in a cookie?), so it's not lost on reload.

zag commented 4 years ago

hi @patrickbkr! 👋 Awesome todo list ! thank you!

patrickbkr commented 3 years ago

I just added one more point to the list.

zag commented 3 years ago

yeah, good point! Thank you for bringing it up. I will try to find some time and get back to https://github.com/highlightjs/highlightjs-raku

patrickbkr commented 3 years ago

And one more. :-) I do like editing with the site a lot.

patrickbkr commented 3 years ago

Oh, actually I meant the highlighting of the HTML! But adding highlighting to the pod definitely also helps. I'll update the comment.

zag commented 3 years ago

yes, also will be good to have: make URL for point to the edited document 👍

zag commented 3 years ago

Oh, actually I meant the highlighting of the HTML! But adding highlighting to the pod definitely also helps. I'll update the comment.

https://github.com/highlightjs/highlightjs-raku is about highlighting the HTML!

zag commented 3 years ago

Add some POD highlighting.

This is also a cool idea to add highlighting source text in the editor depends on the block type, i.e. headers, italic ...

patrickbkr commented 3 years ago

I think I somehow misunderstand. https://highlightjs.org/ is a syntax highlighting library to add highlighting to source code. As such I assumed highlightjs-raku allows adding highlighting to Raku code and POD markup. Is that wrong?

patrickbkr commented 3 years ago

Could improving these projects be good candidate for a GSoC project?

zag commented 3 years ago

https://highlightjs.org/ - javascript library for highlighting <code> sections in HTML for various formats ( included program languages or data formats, like XML )

pod6.in uses https://codemirror.net/ editor for source texts ( which, of course, can be themed and highlighted)

✌️

zag commented 3 years ago

Could improving these projects be good candidate for a GSoC project?

Defiantly yes, adding raku highlighting into highlightjs library [1] - cool candidate. Just in case, check this[2]

thank you!

[1] Raku Language Definition for Highlight.js library https://github.com/highlightjs/highlightjs-raku [2] Raku ideas https://rakudoweekly.blog/2021/02/01/2021-05-gsoc-proposing/

zag commented 3 years ago

✅ Do some SEO so it pops up at the top when googling "pod6 editor" and "pod6 editor online" ✅ Persist edited content (in a cookie?), so it's not lost on reload.

happy typing!

patrickbkr commented 3 years ago

Hooray for persistent editing!

Can you put a "Are you really sure?" on the Reset button?

zag commented 3 years ago

fixed thank you!