JSqlParser - website discussion

[sivaraam]

Let's create a website for the library! This issue is to track the discussion related to the website creation.

[sivaraam]

Jekyll template suggested by @wumpz: Minimal Mistakes

[sivaraam]

@wumpz For the sake of completeness, can you list the information that you wish the website should provide to its visitors?

[wumpz]

Let me think about it:

• quickstart (maven, gradle)
• introduction visitor pattern
• introduction object tree of jsqlparser
• common tasks: parsing, replacing, analyzing
• examples

I think the biggest gap is explaining jsqlparsers object tree. Much of this should go into the javadocs as well.

[sivaraam]

That looks like a good start! I think it would also be nice to add a link to the javadocs.

Anyways, I'll set up an initial webpage based on the Minimal Mistakes template and then we'll add more content to it.

In the mean time, if you would like to host the site at https://jsqlparser.github.io/ instead of https://jsqlparser.github.io/jsqlparser you would have to create a repository in the JSQLParser organization with the name "jsqlparser.github.io" (reference)

[sivaraam]

Hi @wumpz,

Sorry I couldn't get the initial site past weekend. Anyways, I've started looking into it now.

Just wanted to ask you something. Though I initially told the Minimal Mistakes theme was nice. On second thought, it seems to give a dull kind of appearance to the website. So, I think its better to go with some other theme which gives a more appealing look. Let me know your opinion.

If you also agree on choosing an alternative theme, let me know your opinions about the one of these alternatives (or) suggest other ones.

• Hyde
• Beautiful Jekyll

[wumpz]

Beautiful Jekyl looks nice as well. But Minimal Mistakes is kind of a framework. Beautiful Jekyl as well?

[sivaraam]

But Minimal Mistakes is kind of a framework.

I'm not sure what you mean by a framework here. But on taking a closer look, minimal mistakes does look like a more mature and widely used template when compared to beautiful jekyll. So, we can just go with Minimal mistakes if you are fine with it.

The minimal mistakes template does provide some skin variants at our disposal. Let me know your opinion about which one to choose. You can find them in the following link: https://github.com/mmistakes/minimal-mistakes/blob/master/README.md#skins-color-variations

[wumpz]

At first look I would say: air, mint, contrast are my favourites. However this skinning is done using some options, so changeable afterwards.

[AnEmortalKid]

+1 for contrast