Creating a SSG website for this project.

[avinal]

Hello @HarshCasper,

There are lots of SSGs, some of the most popular are Sphinx, Jekyll, and a lot more. More or less they work on the same principle, that is converting Markdown or reStructured Text into HTML.

You may choose any SSG, but Jekyll has an additional advantage that it works natively with gh-pages, no CI/CD required. There are a plethora of themes. As per my experience, I can suggest two ways to create a website for this project.

1. Since every script in this project has a separate readme file. we can just modify them a bit to be included by the site generator recursively (just adding few keywords) and thus site will be generated, you can customize the home page.
2. Create a whole new branch/repo for this purpose and add each script description separately. This gives us slightly more control but it needs huge efforts.

For example you can see these:-

• source: https://code.videolan.org/avinal/vlc-android-user generated-site: https://avinal.videolan.me/vlc-android-user (sphinx)
• https://avinal.is-a.dev (pelican)
• https://idratherbewriting.com/documentation-theme-jekyll/ (Jekyll)

[HarshCasper]

Hello @avinal

Thanks a lot for this information. This made my general conception more clear. Would it be possible for you to work on this, or do I need to configure this from my side?

I guess we can go ahead with a new branch and have the scripts separately. This would give us a lot more control.

[avinal]

Hi @HarshCasper,
Since you want to create a whole new branch, we will need many people and remember whenever someone adds a new script he/she will need to add it to two places, script in main, and doc in another branch, if you are okay with it then we may start working. From your side, you might want to decide the theme and generator and enable the gh-pages. Mostly sphinx with the read-the-docs theme is quite popular and you will see them everywhere.

[HarshCasper]

Hi @HarshCasper,
Since you want to create a whole new branch, we will need many people and remember whenever someone adds a new script he/she will need to add it to two places, script in main, and doc in another branch, if you are okay with it then we may start working. From your side, you might want to decide the theme and generator and enable the gh-pages. Mostly sphinx with the read-the-docs theme is quite popular and you will see them everywhere.

That's a sound opinion. We don't want to over-burden new contributors. I guess we can go with the other one right now. Let me know what theme we would like to finalize on.

If you would like to get access to the repository, let me know.

[avinal]

I don't think access will be needed since I can open a pull request for any change, and its much safer when something goes through multiple eyes.

I would like to use Sphinx because it will be easy for newbies too and theme is not a problem, https://sphinx-themes.org/ , you can change themes anytime by changing few lines, without losing any content, since all themes have basic templates. Also to use all features all of the markdown will need to converted to reStructured Text, they work almost the same way,

[HarshCasper]

I don't think access will be needed since I can open a pull request for any change, and its much safer when something goes through multiple eyes.

I would like to use Sphinx because it will be easy for newbies too and theme is not a problem, https://sphinx-themes.org/ , you can change themes anytime by changing few lines, without losing any content, since all themes have basic templates. Also to use all features all of the markdown will need to converted to reStructured Text, they work almost the same way,

Awesome. You can go ahead!

[github-actions]

@avinal, this issue hasn't had any activity in 7 days. It will become unassigned in 14 days to make room for someone else to contribute.

[avinal]

Hello @HarshCasper, I am starting to convert all readme files from markdown to reStructuredText. Just for safety purposes, I am keeping the actual Readme along with them. If everything works finally then we can remove all markdown in a pull request.

Can you please create a new branch and enable GitHub pages and create another gh-pages branch?

[avinal]

Hello @HarshCasper, I am starting to convert all readme files from markdown to reStructuredText. Just for safety purposes, I am keeping the actual Readme along with them. If everything works finally then we can remove all markdown in a pull request.

Can you please create a new branch and enable GitHub pages and create another gh-pages branch?

@HarshCasper, please see this!

[avinal]

@HarshCasper, Please see if this looks right, I have converted all files to rst using bash scripting and pandoc, just need to connect and resolve issues, it will ready in few days, I will soon be giving a live demo.

P.S - This is a mobile version, just in case you wanted to see

[HarshCasper]

Hello @HarshCasper, I am starting to convert all readme files from markdown to reStructuredText. Just for safety purposes, I am keeping the actual Readme along with them. If everything works finally then we can remove all markdown in a pull request.

Can you please create a new branch and enable GitHub pages and create another gh-pages branch?

I will create the same by Evening. Apologies for missing this out in a drain of notifications.

[HarshCasper]

@HarshCasper, Please see if this looks right, I have converted all files to rst using bash scripting and pandoc, just need to connect and resolve issues, it will ready in few days, I will soon be giving a live demo.

P.S - This is a mobile version, just in case you wanted to see

Damn! This looks awesome 🚀

[avinal]

@HarshCasper, Thanks. This theme has more interesting features, one of the most awesome of them is inbuilt binder support, we can run scripts(mostly python) right on the website. I haven't tried them much but sounds cool.

[HarshCasper]

Hi @avinal

Thanks for the efforts and contributions!

I have created a branch named rotten-scripts-website and enabled GH-Pages over it. Let me know if you need anything else.

Also as a gentle request, can you please create a new discussion thread and post all your progress over there? It would be easier, to take a look over the progress and let the other contributors share their opinions. Thanks for everything!

[avinal]

sure @HarshCasper, will do that by tomorrow.