search

lisp-docs / cl-language-reference

Common Lisp New Language Reference
https://lisp-docs.github.io/cl-language-reference/
MIT License
11 stars 0 forks source link

Some docs seem to be filled with `|:-|` and `|` #3

Open ispringle opened 9 months ago

ispringle commented 9 months ago

First, love the site, it's so nice to use, thank you.

The site seems to have a lot of random characters in it, such as | on their own line or this ligature |:-|. I figure this is an artifact from the conversion process or something. Would this be something that could be cleaned up? I'd be happy to contribute some time to the effort.

https://github.com/lisp-docs/cl-language-reference/blob/dbdac0a6ae828d5f95d33db1b5f39f9bb70f8a70/docs/chap-2/c-b-character-syntax/_c-b-b-readtables.md?plain=1#L15

EDIT:

image Looks like this might be an artifact from the source that was trying to express these items in a box. So maybe remove the chars and add a component to indicate that they need to be styled appropriately?

daninus14 commented 9 months ago

Hi @ispringle ,

Thanks for the feedback.

Yeah, that's exactly right. Those are usually tables. I was parsing the generated markdown by making scripts.

I've invested a lot of time to do this, and right now I'm too swamped by other things to be able to focus on it. Your contribution is greatly appreciated!

Here's a link with details on this table issue

I think there's usually a line between that | :- | and some other |content here|. If the line is removed, it shows up as a table or a box. The problem is it still needs to be formatted.

Here's the markdown table syntax: https://www.markdownguide.org/extended-syntax/#tables

The question is if it'll render nicely or not. If it doesn't, then we should probably make a simple html table or just use html to style it. How to do it is up to you.

Docusaurus uses this css library by default: https://infima.dev/docs/getting-started/introduction but you can add any css you want in the global css file (not sure where it is right now, but just search in your code editor for .css files, I think there shouldn't be more than a few, maybe only one, and the location of the files should give away which one is the global one.

In short: you can either make a manual change or make a script to try to fix the whole reference. It should be possible to catch most cases with regex. Whether you make a manual change or a script, please explore how to format the information so that it looks nice and readable.

Thanks! Let me know if I can help with any guidance

ispringle commented 9 months ago

Thanks for the guidance. I'll poke at this after the weekend. Cleanup shouldn't be too hard and then it'll just be a matter of styling it.