Code Monkey home page Code Monkey logo

search's Introduction

Search

assets/search.png

This is an interface that uses GitHub pages and the API that is provided there to render a searchable interface of repositories for an individual or organization. See this post for a review of how it works.

Usage

To use this repository for your organization, just fork it there, and turn on GitHub pages! By default, this will render an interface at <account>.github.io/search. If you want to change this, simply rename the repository, and be sure to change the baseurl variable in _config.yml. You'll also likely want to change the title (appears in the top left)

title:        vsoch/search
baseurl:      "/search"

The repository variable is required to run the "github-pages" plugin locally.

repository:    vsoch/search

If you haven't already, you would need to install Jekyll and then install dependencies using the Gemfile:

bundle install

Rendering the site locally can be done as follows:

bundle exec jekyll serve

Warning it's fairly easy to use up your rate limit rendering locally. I recommend working carefully and doing a test when you are ready, and using GitHub pages to render for you (I didn't seem to ever get any messages about limits when I pushed there, however I tried to do this conservatively).

Customize

You are free to customize the style as you please, and specifically the color of the "scroll to top" bottom can be customized from the _config.yml.

# Scrolltop color
scrolltop_color: "#fd1268"

I chose a pink that matches my GitHub icon, and I suspect you'd want to do the same for your user or organization account.

Contributing

Would you like to contribute to vsoch/search to make it better? Please open an issue with a question, issue, or anything else you'd like to discuss.

search's People

Contributors

vsoch avatar rom1detroyes avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.