search

Futura-Py / TimerX

A fluent Timer App, made completely in Python
https://timerx-app.netlify.app
MIT License
37 stars 5 forks source link

Request to make a documentation/homepage site using SSGs #23

Closed im-coder-lg closed 2 years ago

im-coder-lg commented 2 years ago

We could also use Jekyll that can use Vercel... Let's take Jekyll, that's widely supported and we will use Netlify for the website deployment since it has Netlify CMS that could allow us to edit without going to GitHub.

Originally posted by @im-coder-lg in https://github.com/sumeshir26/TimerX/issues/21#issuecomment-1000204245

In another project called Xplorer(it's best to quote this here so that it might help), they use a NodeJS framework called Docusaurus. SSGs I know:

  1. CODEDOC(stands out for documentation and its special Markdown syntax but doesn't work on Netlify, Vercel, etc.)
  2. Jekyll(blogs, websites, too much JavaScript)
  3. Next.js(too static but fast as lightning)
  4. Docusaurus(never tried this from scratch)

Any ideas on other SSGs? No Gatsby since that seems too complex. The font is kinda bad too(no offence gatsby, I like Montserrat).

im-coder-lg commented 2 years ago

Which one can we use for the website? We have Vercel as deployment+hoster, Netlify as a solid alternative if we use their CMS, and GitHub Pages(no PR preview like Vercel :() too.

im-coder-lg commented 2 years ago

I'm assigning this to myself since I am kind of an expert when it comes to this.

im-coder-lg commented 2 years ago

Documentation: https://pmarsceill.github.io/just-the-docs/

Homepage... Let's use CODEDOC, I told you above that it has a special Markdown syntax for it and using that, we could make users see Light mode and Dark Mode of TimerX, all with a click of a button. It's smooth too.

im-coder-lg commented 2 years ago

Started development: website.

im-coder-lg commented 2 years ago

/ping @sumeshir26

sumeshir26 commented 2 years ago

Okay, tell me when its done

sumeshir26 commented 2 years ago

How do I test this? Is this on vercel?

im-coder-lg commented 2 years ago

How do I test this? Is this on vercel?

Not yet. I need to configure the websites, add theming to CODEDOC so that it doesn't look too alien, check the JTD theme, but I will make a PR after I succeed on them. PS: It will have a lot of commits.

im-coder-lg commented 2 years ago

Right now, here's what I've accomplished:

What I must do soon: