search

the-ethan-hunt / first-timers-guide

A collection of guides for and by first-timers
MIT License
180 stars 199 forks source link

[Improvement] Created/Added a Website #64 #221

Closed EdgeKing810 closed 5 years ago

EdgeKing810 commented 5 years ago

Did you read the instructions in the README?

Y

Have you read the instructions in CONTRIBUTING?

Y

Have you written this article by yourself? Have you taken inspiration from anywhere and then written it in your words?

I have not taken up any articles. Just copied and converted the README.md into the index page for the website.

This is a page for https://github.com/the-ethan-hunt/first-timers-guide/issues/64. If this is approved, I'll work on https://github.com/the-ethan-hunt/first-timers-guide/issues/216 too.

EdgeKing810 commented 5 years ago

Also, please let me know of any possible improvements or what I must do more.

EdgeKing810 commented 5 years ago

nvm, I'm taking and fixing #216 along

EdgeKing810 commented 5 years ago

Also, please let me know of any possible improvements or what I must do more.

again that for issue #216 too...

the-ethan-hunt commented 5 years ago

Issue #216 is taken care of; Is this PR WIP for Issue #64 ? @EdgeKing810 would it be great to host this website on Jekyll? An ideal website for this project: The homepage should feature a search bar whereupon typing the first letter, a list of options come up; similar to Google Search. Would like to hear your opinion on this.

EdgeKing810 commented 5 years ago

Thanks for the response. To start, I'm having a little misunderstanding for

issue #216 is taken care of;

Are you trying to say that my PR is fixing #216 or it has been fixed by someone else? Please clear this doubt.

Then, if you want me to make the website in HTML/CSS instead of Jekyll, I've no problems with that. And for the search you are talking about... if I understood correctly, the search function will return links of .md files of this repo as per the user's search? I don't really know how to do that since I'm not too experienced with JavaScript but I could probably do it with some searches.

Also, I'll need some more details for the index.html file that I'll probably need to make.

As per my understanding so far, the above mentioned file will be quite similar to the README.md except that I need to implement a sort of search function as I was talking 2 paragraphs above. Do let me know about this and I'll work on it.

EdgeKing810 commented 5 years ago

[Latest Comment bases on the latest commits]

I've replaced index.rst with index.html. Note that I have not added any CSS yet. I'll need some answers for my comment before this one and if you want any CSS styling done, lemme know in which elements and stuff you'd want it @the-ethan-hunt.

As far as the search option is concerned, I need to make sure that I understood it correctly and whether it should return links of .md files of that repo based on the search keywords.

the-ethan-hunt commented 5 years ago

@EdgeKing810 : This PR has solved Issue #216 . Your search idea is correct, indeed. That's what we need to do: the search function will return links of .md files of this repo as per the user's search. Regarding the CSS part, you are free to work upon it as you like; I don't recommend or support any particular styling, it depends on the contributor. :smile:

EdgeKing810 commented 5 years ago

Okay then, I'll work on that search function and try to add some CSS. :smiley:

EdgeKing810 commented 5 years ago

Hey @the-ethan-hunt! Managed to do the search thing you asked me! :tada:

I also got to learn some JavaScript and I honestly love it! In that latest update, I also made some minor improvements in the docs so that they appear a bit better. And for the CSS part, I have not done much things but I put classes with some of the elements, so... tweak them according to your preference if you want!

I hope you like the work I did! If you need other improvements to be done or if you are not satisfied, please let me know!

the-ethan-hunt commented 5 years ago

@EdgeKing810 , excellent work indeed! :tada: Let's launch it!

EdgeKing810 commented 5 years ago

Yayy :smile: