Git Product home page Git Product logo

rubyref's Introduction

rubyref.net - Ruby documentation redirects

Source code for https://rubyref.net - a shorthand for navigating to Ruby documentation. Inspired by nocduro/rustref.

Examples:

awesome.rubyref.net → https://github.com/markets/awesome-ruby
book.rubyref.net → http://ruby-doc.com/docs/ProgrammingRuby/
capi.rubyref.net → https://docs.ruby-lang.org/en/trunk/extension_rdoc.html
...

Built with Middleman, Netlify and CloudFlare

The initial version built with Roda can still be seen in the roda branch.

Overview

Middleman builds out a static index.html which gets deployed to Netlify. A Cloudflare page rule redirects all requests to *.rubyref.net (except for www) to https://rubyref.net/redirect/*. This either uses a cached value at Cloudflare or gets redirected by Netlify.

All redirect information is stored in redirects.json. Since Cloudflare does not offer wildcard proxied CNAME records, the cloudflare:update_cnames Rake task uses the Cloudflare gem to set them via the API before a new version of the app is deployed.

CSS copied inspired by http://neverssl.com via http://rustref.com.

Hosting/architecture

Browser -> Cloudflare (free tier) -> Netlify (free tier)

Contributing

Modify redirects.json with a new redirect (in alphabetic order) then make a pull request.

rubyref's People

Contributors

citizen428 avatar coderhs 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.