GithubHelp home page GithubHelp logo

shadowfiend / sophocles Goto Github PK

View Code? Open in Web Editor NEW
3.0 2.0 0.0 51 KB

A new way to do tutorial blogging—with git!

Home Page: http://shadowfiend.svbtle.com/

License: MIT License

CoffeeScript 86.90% Ruby 1.42% JavaScript 2.72% CSS 6.76% HTML 2.20%

sophocles's Introduction

Sophocles

Sophocles is a re-imagining of our approach to writing tutorial blogs. Typically, we see text interspersed with code. It can be hard to focus on the changes, sometimes, or to see them out of context. With Sophocles, I realized that git was an ideal tool for describing sets of changes. With some small adjustments to how we use git itself, we can make the elements of a set of git commits a tutorial.

When using Sophocles, every commit is one “step” in your tutorial. The changes in the commit are the changes for that step, and the commit message is the description of what those changes do. Sophocles then formats these in a way that is easy to read.

Sophocles is a Node.js application. The intent is for it to be easily deployed to heroku so anyone can run a Sophocles blog. Not quite there yet, but work is ongoing in my spare time!

License

Sophocles is provided under the terms of the MIT License. See the LICENSE file in this same directory.

Author

Sophocles is copyright me, Antonio Salazar Cardozo, and licensed uner the terms of the MIT License. No warranties are made, express or implied. See the LICENSE file in this same directory for more details.

I have a rather sporadically updated blog at http://shadowfiend.svbtle.com/.

I am the Head of Engineering at Thesis, where we're working on bringing power back to the individual through decentralized systems.

sophocles's People

Contributors

shadowfiend avatar

Stargazers

 avatar  avatar  avatar

Watchers

 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.