Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vsoch/search
a search interface for any user account or organization
https://github.com/vsoch/search
gh-pages github-pages jekyll search template
Last synced: 2 months ago
JSON representation
a search interface for any user account or organization
- Host: GitHub
- URL: https://github.com/vsoch/search
- Owner: vsoch
- Created: 2020-02-28T23:26:30.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T00:42:01.000Z (7 months ago)
- Last Synced: 2024-05-23T01:40:10.046Z (7 months ago)
- Topics: gh-pages, github-pages, jekyll, search, template
- Language: JavaScript
- Homepage: https://vsoch.github.io/search
- Size: 264 KB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Search
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](https://vsoch.github.io/2020/github-search/) 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 `.github.io/search`.
If you want to change this, simply rename the repository, and be sure to change
the baseurl variable in [_config.yml](_config.yml). You'll also likely
want to change the title (appears in the top left)
```yaml
title: vsoch/search
baseurl: "/search"
```
The repository variable is required to run the "github-pages" plugin locally.
```yaml
repository: vsoch/search
```
If you haven't already, you would need to [install Jekyll]() and then
install dependencies using the [Gemfile](Gemfile):
```bash
bundle install
```
Rendering the site locally can be done as follows:
```bash
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](_config.yml).
```yaml
# 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](https://github.com/vsoch/search) with a question, issue,
or anything else you'd like to discuss.