Git Product home page Git Product logo

directory's Introduction

Gem Version Linux Build Status Windows Build status Backers on Open Collective Sponsors on Open Collective

Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind GitHub Pages, which you can use to host sites right from your GitHub repositories.

Philosophy

Jekyll does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content.

See: https://jekyllrb.com/philosophy

Getting Started

Diving In

Need help?

If you don't find the answer to your problem in our docs, or in the troubleshooting section, ask the community for help.

Code of Conduct

In order to have a more open and welcoming community, Jekyll adheres to a code of conduct adapted from the Ruby on Rails code of conduct.

Please adhere to this code of conduct in any interactions you have in the Jekyll community. It is strictly enforced on all official Jekyll repositories, websites, and resources. If you encounter someone violating these terms, please let one of our core team members know and we will address it as soon as possible.

Credits

Sponsors

Support this project by becoming a sponsor. Your logo will show up in this README with a link to your website. Become a sponsor! Jekyll Sponsor 0 Jekyll Sponsor 1 Jekyll Sponsor 2 Jekyll Sponsor 3 Jekyll Sponsor 4 Jekyll Sponsor 5 Jekyll Sponsor 6 Jekyll Sponsor 7 Jekyll Sponsor 8 Jekyll Sponsor 9

Contributors

This project exists thanks to all the people who contribute. Jekyll Contributors

Backers

Thank you to all our backers! 🙏 Become a backer

Jekyll Backers

License

See the LICENSE file.

directory's People

Contributors

ashmaroli avatar chrisfinazzo avatar crunch09 avatar dirtyf avatar dlitvakb avatar envygeeks avatar erikw avatar jekyllbot avatar parkr avatar pathawks avatar strangehill avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

directory's Issues

Remove gh-pages branch

Now that our site lives in master, may we delete the gh-pages branch to avoid confusion?

Rename gh-pages to master

How do you feel about changing the name of the gh-pages branch to master?

Since the website is the main (only) thing this repository is tracking, it makes sense to me that it would be the master branch. The gh-pages branch feels like it would be better suited for documentation regarding another project, rather than the primary branch of the project.

Thoughts?

Import plugins from GitHub

Crazy idea: What if we programmatically pulled plugins from GitHub that contained the tag jekyll-plugin?

Use Travis CI to download Rubygems data for listed gems

The following Rake task takes the directory listing (_data/themes.yml and _data/plugins.yml clubbed into a single _data/entries.yml) and downloads each gem into their respective directory

# frozen_string_literal: true

require "rubygems"
require "rake"
require "open-uri"
require "safe_yaml"

task :default do
  entries = SafeYAML.load_file("_data/entries.yml")
  entries.each do |type, list|
    FileUtils.mkdir_p("_data/#{type}")
    list.each do |item|
      begin
        data = open("https://rubygems.org/api/v1/gems/#{item}.yaml").read
        File.open("_data/#{type}/#{item}.yml", "wb") { |file| file.puts data }
      rescue OpenURI::HTTPError
        puts "#{item} does not seem to exist at rubygems.org"
        next
      end
    end
  end
end

The data files can then be used to define the front end..
We can then set up Travis to download these files at a set interval..
Thoughts?

Improve tests

I wonder if we could whip something up that runs when the site is built on CI that verifies that all Gems exist, and URLs don't 404.

Seems like it’d be as easy as adding something to _plugins/

Spec failure doesn't cause tests to fail

It seems that if spec/plugins_spec.rb fails but HTML-Proofer succeeds, script/cibuild will exit with 0 and cause CI to pass when it should have failed because of spec/plugins_spec.rb.

Perhaps we don't even bother running HTML-Proofer if we find errors before that stage?

How to List RubyGems(.org) Jekyll Plugins

I think this site has potential to be a great place to discover gemified Jekyll plugins. The potential I see, however, does not mean it can actually be useful and therefore that we should use it. Any thoughts on this?

Search

needs search functionality (maybe over archive page?)

Plugin organization

A couple questions/suggestions related to plugin organization:

  1. Categories or tags?
    Some of the plugins don't fit easily into single categories. For instance, a plugin that is both a generator and a tag to interact with that generator. I think tags would work well here.
  2. Two tag "types", plugin type and purpose?
    Having a hard time thinking up good names for these, but I think it would be good to have two types of tags, one for the plugin type (e.g., tag, generator, other), and one to group the plugin by purpose (e.g., images, code, asset pipeline, performance).
  3. Collections?
    I think where people have more than one plugin in a repo it would be good to list each plugin separately but point to the same url. Thoughts?

Specify compatibility

Does this seem realistic?

As a Jekyll Plugin Author
I can include information concerning the compatibility of my plugin

Success criteria

  • Plugin author receives a notification/PR asking him to specify plugin compatibility
  • PR contains informations on how to commit the info to this repository
  • compatible: v3 can be specified in the FrontMatter
  • compatibility is displayed on the plugin page

Message

Hi ,

We want you to know that Jekyll plugin directory is moving to a dedicated website. The current page on Jekyll documentation will redirect to the plugin directory once we're done with the migration.

In order to help users choose from the listing, it would be nice if as the plugin author you could tell us with which Jekyll versions your plugin has been tested.

In order to do so, pick or add your plugin in the _plugins folder in the repository, edit the FrontMatter and add one of the following values:

compatible: [v2,v3] 
compatible: v2
compatible: v3

Thanks a lot for your help!
With ❤️ from the Jekyll Core Team

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.