Skip to content
This repository has been archived by the owner on Mar 16, 2022. It is now read-only.

Adds basic bower package file #10

Closed
wants to merge 56 commits into from
Closed

Adds basic bower package file #10

wants to merge 56 commits into from

Conversation

daviddarnes
Copy link
Contributor

I've created a basic bower package install file. You'll obviously need to make your own changes to it, but I tried to put as much info related to your repo in it as I could.

I'd advise some kind of clean up on the repo a little, not that it's a major issue. Using bower to install the plugin means that users, like me, can use gulp and hook into the main bower file to bring only what's needed into the main project files.

I'd make the search.json file a dependancy so people can deal with the file separately to the main plugin.

@christian-fei
Copy link
Owner

Thank you very much :)
I'll look into it.
I'm currently adding tests and essentially rewriting the plugin, because I see an utility for it.

@daviddarnes
Copy link
Contributor Author

Great! I'm using it right now for a work project :)

Also, maybe the search.json should just be a main file? Considering it's just for jekyll it should always be in the project. Plus dependancies tend to be external sources.

search.json is required for the plugin to work on Jekyll sites.
@daviddarnes
Copy link
Contributor Author

FYI don't go mad with the rewriting! It works perfectly right now :).

@christian-fei
Copy link
Owner

Interesting, the search.json file could be moved to the example only, in fact..

I'm sorry but I have to rewrite it, because I learned a lot of stuff in the last months and I want to apply them :)

The API will change, but not dramatically, I hope

@daviddarnes
Copy link
Contributor Author

I wouldn't move it into the example, people who use the plugin will need it?

I'd advise putting the example in a gh-pages branch so you can host the example and keep it out of the master branch, which will mean the whole download will be a lot smaller.

Well that's ok, as long as the implementation doesn't really change. Was so easy to add into my project 👍

@christian-fei
Copy link
Owner

Yes I was thinking about a completely separate GH-Pages branch.
I thinks it's best If i reset this git repo, and start over.
The search.json file could be in the GH-Pages branch as well as in the readme for reference.
Thanks

@daviddarnes
Copy link
Contributor Author

Sounds good. I'd structure it something like this:

repo:

  • master
    • jekyll-search.js
    • jekyll-search.jquery.js
    • search.json
    • README.md
    • bower.json
  • gh-pages
    • jekyll site at root
    • bower.json that brings in the plugin into the site
    • gulpfile.js that implements the jekyll-search.js file and the search.json file in the right places

@christian-fei
Copy link
Owner

+1

@daviddarnes
Copy link
Contributor Author

Get it submitted to bower too, "jekyll-search" as a package name hasn't been taken.

@daviddarnes
Copy link
Contributor Author

Would you like me to recreate this pull request to match your newly revised project?

@christian-fei
Copy link
Owner

Thanks :)
Yesterday I posted this repo on Hackernews, got lots of love for it!

@daviddarnes
Copy link
Contributor Author

Ace! Is it stable and useable right now? Or are you still working on it?

@christian-fei
Copy link
Owner

I would say it's way more stable than the last version, tests pass and rewrote it to be easily maintainable. It's totally usable. The previous version was a nightmare.

@daviddarnes
Copy link
Contributor Author

Good to know, I'll close this pull request as I've submitted the file under a new one now.

@daviddarnes daviddarnes closed this Nov 3, 2014
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants