Skip to content

feat(surprise): Website by Docusaurus#26

Merged
sumeshir26 merged 29 commits intoFutura-Py:masterfrom
im-coder-lg:website
Jan 1, 2022
Merged

feat(surprise): Website by Docusaurus#26
sumeshir26 merged 29 commits intoFutura-Py:masterfrom
im-coder-lg:website

Conversation

@im-coder-lg
Copy link
Copy Markdown
Member

@im-coder-lg im-coder-lg commented Dec 27, 2021

We got some good progress going on here!
I am using Docusaurus. Yes, the same is being used at Xplorer. I initially took it for a test and it works really well. You have documentation, a beautiful React-based landing page. You got JAMStack as well as Vercel support which has PR previews. Once I got everything good for the initial part, I'll merge this myself and I will take care of the website.
This is for tracking progress(credits to @not-nef for that part, best to keep you all informed too), as well as some other goodies like bonus points, syntax, etc.

So, here are my next steps to do:

  • Add favicon(I have a generator tool, but I wonder if we use the TimerX Windows logo)
  • Documentation
  • Redesign the landing page
  • Remove the blog part(yeah it has that too)
  • Configure URLs
  • I don't know, any ideas?
  • Merge.
  • @sumeshir26 has to do these tasks, they are kinda easy, that's how we set up Vercel CDNs(is that what it's called?).

pls ack

Closes #23

@im-coder-lg im-coder-lg self-assigned this Dec 27, 2021
@im-coder-lg
Copy link
Copy Markdown
Member Author

Wait how is it 9008+ additions? Deleting the blog part!

@sumeshir26
Copy link
Copy Markdown
Member

Can you share a screenshot?

@sumeshir26
Copy link
Copy Markdown
Member

And from now on, only Squash and Merge to not spam tens of commits on the main branch

@im-coder-lg
Copy link
Copy Markdown
Member Author

Can you share a screenshot?

My Gitpod slowed down, it's weird since this never happened to me. I will switch my browser and send the screenshot.
Can you keep the vercel app installed on your account? After merge, we need to deploy there.

@sumeshir26
Copy link
Copy Markdown
Member

Okay

@im-coder-lg
Copy link
Copy Markdown
Member Author

image
Link for live preview: https://3000-jade-mandrill-5z10h3jc.ws-us25.gitpod.io/
Keep refreshing tho if you need to see recent changes.

@im-coder-lg
Copy link
Copy Markdown
Member Author

I figured out how to add and customize the documentation.
Also, Docusaurus has special syntax, it looks like this:

:::danger <!--can also be tip and adding this on the line becomes the title-->

Content(add the spacing above and below)

:::

Till now, favcion replaced, links changed, documentation removed.
Blog removed too.
@im-coder-lg
Copy link
Copy Markdown
Member Author

We are clearly making progress here! @sumeshir26 do you have any kind of idea to compile/transform Markdown to JSX? It turns out that you need to use JS/JSX for the landing page.

@im-coder-lg
Copy link
Copy Markdown
Member Author

Also, I literally tricked Vercel to accept another branch of my fork, so we might be in luck for GitHub edits as of now.

@im-coder-lg
Copy link
Copy Markdown
Member Author

https://docusaurus.io/docs/markdown-features/admonitions
This was the syntax, admonitions. We could use this to show dangerous things a person might end up doing/notes/tips.

@sumeshir26
Copy link
Copy Markdown
Member

To convert try demo.showdown.com

@im-coder-lg
Copy link
Copy Markdown
Member Author

themeConfig:
  /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
/* code above */
+++      colorMode: {
+++        defaultMode: 'light',
+++        disableSwitch: false,
+++        respectPrefersColorScheme: false,
+++        switchConfig: {
+++          darkIcon: '🌙',
+++          darkIconStyle: {
+++            marginLeft: '2px',
+++          },
          /*
          Unicode icons such as '\u2600' will work
          Unicode with 5 chars require brackets: '\u{1F602}'
          but I don't get the point of unicodes when we have GitHub emojis, right?
          // this is old. lightIcon: '\u{1F602}',
          */
+++          lightIcon: '\u{1F4A1}',
+++          lightIconStyle: {
+++            marginLeft: '1px',
+++          },
+++        },
     },

New additions yet to commit, what do you think? Straight from Docusaurus.

@im-coder-lg
Copy link
Copy Markdown
Member Author

I don't see the point of a dark mode icon, it's barely visible for me. Anyway, I'll commit it and test Vercel deployments.

I will try following the pro way of naming commits.
@im-coder-lg
Copy link
Copy Markdown
Member Author

It works neatly with Unicodes! I'm going to ask users to use Compart.com when it comes to editing icon unicodes here.
Ready for merge! Only one last thing to do for me.

@im-coder-lg im-coder-lg mentioned this pull request Dec 29, 2021
That would ask more people to contribute and help us.
@im-coder-lg
Copy link
Copy Markdown
Member Author

Ready for merge! For me, it's LGTM, except for the huge additions and deletions(idk why maybe the millions of JS files that were ignored or what?).
If this is ready to get on master, these are the steps you(@sumeshir26) need to do:

  1. Approve so that I'll merge when I get the chance, and squash to merge ofc.
  2. Get a Vercel account, install the app for TimerX(if you want, your whole account so that it might help in other websites you make)
  3. Make a project for this repo.
  4. Wait until build succeeds.
  5. Go to Settings > Domains and configure the domain to timerx.vercel.app.
  6. Go to the Deployments tab, click on the hamburger menu button for the successful build and promote to production.
  7. Once it's ready, add the URL here.
    After that, every PR will have a Vercel comment to preview the docs to make sure nothing breaks.
    You must authorize it though, it's a headache, I know.

@im-coder-lg
Copy link
Copy Markdown
Member Author

Latest: https://timer-x-fork.vercel.app

@im-coder-lg
Copy link
Copy Markdown
Member Author

/ping @sumeshir26

@not-nef
Copy link
Copy Markdown
Member

not-nef commented Dec 29, 2021

sick

@im-coder-lg
Copy link
Copy Markdown
Member Author

sick

yeah too sick as heck(i hate swearing)

@im-coder-lg
Copy link
Copy Markdown
Member Author

/ping @sumeshir26 why aren't you responding at all?

@im-coder-lg im-coder-lg requested review from sumeshir26 and removed request for sumeshir26 December 30, 2021 12:56
@im-coder-lg
Copy link
Copy Markdown
Member Author

rerequesting review

@sumeshir26
Copy link
Copy Markdown
Member

@im-coder-lg wait for a few days

@im-coder-lg
Copy link
Copy Markdown
Member Author

Ah now we got a reply! Check #25 too, @not-nef needs your help.

@im-coder-lg
Copy link
Copy Markdown
Member Author

But I recommend merging this since that'd decrease additions. No idea than that since that'd be better.

@im-coder-lg
Copy link
Copy Markdown
Member Author

im-coder-lg commented Dec 30, 2021

Also, a suggestion, we could also use this for icons. I know Vercel'd curve the icons a bit, but I genuinely think the about button icon must come from here.

@im-coder-lg
Copy link
Copy Markdown
Member Author

im-coder-lg commented Dec 31, 2021

<svg viewBox="0 0 24 24" width="24" height="24" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" fill="none" shape-rendering="geometricPrecision" style="color:var(--geist-foreground)"><circle cx="12" cy="12" r="10" fill="var(--geist-fill)"/><path d="M12 16v-4" stroke="var(--geist-stroke)"/><path d="M12 8h.01" stroke="var(--geist-stroke)"/></svg> and <svg viewBox="0 0 24 24" width="24" height="24" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" shape-rendering="geometricPrecision" style="color:var(--geist-foreground);--geist-fill:currentColor;--geist-stroke:var(--geist-background)"><circle cx="12" cy="12" r="10" fill="var(--geist-fill)"/><path d="M12 16v-4" stroke="var(--geist-stroke)"/><path d="M12 8h.01" stroke="var(--geist-stroke)"/></svg>. how's this? PS: about page icon suggestion.

@sumeshir26
Copy link
Copy Markdown
Member

Ok

@im-coder-lg
Copy link
Copy Markdown
Member Author

Ok

For the SVG or merging? Need some more context.

@sumeshir26
Copy link
Copy Markdown
Member

Svg

Seems unrelevant but the Gitpod image...
That is to blame.
Stupid me
@sumeshir26 sumeshir26 merged commit 48eb14e into Futura-Py:master Jan 1, 2022
@im-coder-lg
Copy link
Copy Markdown
Member Author

Starting the next changes soon.

@im-coder-lg
Copy link
Copy Markdown
Member Author

YOu got Vercel?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Request to make a documentation/homepage site using SSGs

3 participants