Giter Site home page Giter Site logo

rfcdash's Introduction

rfcdash

rfcdash is a docset for Dash.app containing all published RFCs from the IETF.

Dash screenshot showing RFC 2324

Installing

Install by opening Dash.app preferences, switch to Downloads, open User Contributed, and search for "RFCs". If you prefer, you can also subscribe to the docset feed URL at https://raw.githubusercontent.com/willnorris/rfcdash/master/RFCs.xml. The unpacked docset will take a little over 500 MB on disk.

Updating the Docset

Most people generally shouldn't need to update the docset on their own. It's generally easier for me to do it, so these notes are mainly for myself. If you notice that the docset is missing an RFC that you need, just open an issue and I'm happy to update it.

Updating requires:

To grab the latest RFCs, run the sync script. This will use httrack to download all published RFCs from the IETF website. This typically takes about half an hour because it downloads everything every time. This is necessary because new RFCs sometimes update or obsolete older RFCs, so we grab everything to make sure we have the latest.

Once everything is downloaded, run rebuild.py to build the index file, rebuild the search index, and add tables of contents to each RFC.

Manually update the index page to use relative links by running:

gsed -r -i 's/href="http:\/\/tools\.ietf\.org\/html\/0*([[:alnum:]]+)"/href="..\/html\/rfc\1\.html"/g' RFCs.docset/Contents/Resources/Documents/tools.ietf.org/rfc/index.html

License

The RFCs themselves contained in this repo are subject to the IETF IPR policy. The scripts used to construct the docset are released under an Apache 2.0 license.

rfcdash's People

Contributors

willnorris 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.