Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make this a bit more navigable via docusaurus and github pages? #1

Closed
viditmaniyar opened this issue Feb 17, 2020 · 7 comments
Closed

Comments

@viditmaniyar
Copy link

viditmaniyar commented Feb 17, 2020

I propose we add something like docusaurus to this site and host this on github pages?

I spent a few minutes to quickly set this up on my local and it looks something like this -
image

It will do the following -

  • Give the information a better structure and navigation.
  • Ability to host this on pages means that this can be user-friendly to people who don't get intimidated by github.
  • We can still create content in markdown, so that's nice.
  • Just better look and feel
  • Responsive UI

Here's a branch on my fork to see what the code looks like.

@jotpowers
Copy link
Owner

I like this idea a lot. I'm probably going to do a big reorg of the content over the next few days (yay flight time!) but then maybe after that we can go forward. I'll see what I can figure out from it and reach out if I need some help.

What are your thoughts on this vs github pages?

@JemDay
Copy link

JemDay commented Jun 9, 2020

I like the look of this, and have other areas where I I'd like to use an approach such as this.

My mental block is the process that builds the content into the GitHub Pages structure - do you have a pointer/reference for that ?

@JemDay
Copy link

JemDay commented Jun 9, 2020

Just answered my own question ...

https://docusaurus.io/docs/en/tutorial-publish-site

@jotpowers
Copy link
Owner

Ok, so it isn't complete yet, but I finally used some time off to take a shot at this. Please review:

https://jotpowers.github.io/ds/docs/introduction/

Everything isn't linked up because I haven't ds'd all the files and I'm reworking the organization but I think you can see the overall plan. LMK.

@jotpowers
Copy link
Owner

I feel like this is now complete. :)

@viditmaniyar
Copy link
Author

@jotpowers This looks great Jot! Thanks!

And @JemDay, glad you found the docs, I totally missed your comment from last year :D

Happy new year both!

@jotpowers
Copy link
Owner

Thanks for bringing it up. I never would have considered it on my own. :)

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

No branches or pull requests

3 participants