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

New Website - Suggestions #837

Closed
janishutz opened this issue Dec 12, 2022 · 14 comments
Closed

New Website - Suggestions #837

janishutz opened this issue Dec 12, 2022 · 14 comments

Comments

@janishutz
Copy link
Contributor

I am currently working on a new website. I am currently elaborating my font choices, but I can't seem to come to a conclusion. Any suggestions? You can find the current state of development here

@janishutz
Copy link
Contributor Author

I have some suggestions for fonts (just head to fonts.google.com and search for the font):

  • Imprima
  • Ubuntu
  • Quicksand
  • Josefin Sans
  • Exo 2

Some random suggestions I liked, but may not be the best...

  • Lobster
  • Cairo
  • Dancing Script
  • Pacifico

@janishutz
Copy link
Contributor Author

I have now started thinking about how to implement docs. I was thinking about using readthedocs first, but then I wanted to do it on my own using mdToHtml, as I feel like that'd be the easiest.

@janishutz
Copy link
Contributor Author

I was thinking about just loading and unloading the selected pages, so we technically just have one wiki page with impress-like urls

@henrikingo
Copy link
Member

This is hard to comment on without seeing some concrete demo/example.

But thank you for doing this, I really appreciate it.

@janishutz
Copy link
Contributor Author

I can upload a demo to https://impress-testing.janishutz.com this evening, maybe this afternoon, if I don't get IP blocked by DirectAdmin.

@janishutz
Copy link
Contributor Author

okay I am kinda forgetful, so I forgot, but added a reminder and will add it in about 2-3 hours

@janishutz
Copy link
Contributor Author

I have spend some more time thinking about how the documentation should be assembled. I feel like I should create a script that automatically takes all the README.md files of the plugins, the Getting Started Guide and some custom pages. I will use the DOCUMENTATION.md and README.md files of impress itself to create a more user friendly experience that is just on the website with simple navigation. This should allow new users to have a more curated experience whilst obviously still having the repo for more advanced users.

@henrikingo
Copy link
Member

Okay that sounds like a good start!

@fnogatz
Copy link
Contributor

fnogatz commented Jan 17, 2023

Thank you for the efforts, @simplePCBuilding. For me, this sounds more and more like the website with its build script should be better put into a separate repository in the https://github.com/impress namespace. What do think?

Another question, just out of curiosity. Have you ever thought about building the website and documentation with impress.js itself? After all, impress.js already includes a mechanism to re-use files written in markdown directly (see markdown example). In addition, the wiki includes some neat examples where people did similar for their personal websites, e.g. https://tarjomyar.ir/

@janishutz
Copy link
Contributor Author

janishutz commented Jan 17, 2023

Didn't think about that, great suggestion. I just noticed it is sorta confusing on mobile sometimes.

And about different repository... I think that would be the best idea, although we then would need to update that repo whenever there's a change in documentation, which is technically no problem

@janishutz
Copy link
Contributor Author

I have also noticed another problem. The links in the MD are relative ones. I would need to build a full source map to correctly link between the files. I have an idea on how to do it, which would require that a change to the repo structure will also be made to the link replacing unit.

@janishutz
Copy link
Contributor Author

I have mostly figured out the link parsing. I will finish it probably either this afternoon or this evening (it is currently 10:30AM for me)

@janishutz
Copy link
Contributor Author

I will today also update the demo website (https://impress-testing.janishutz.com/) with the newest changes from my fork

@janishutz
Copy link
Contributor Author

#847 continuing there

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