GithubHelp home page GithubHelp logo

writetheman's Introduction

Writetheman

Create, show and list the middleman blog articles.

It's used by my middleman editor RailsTheMan to manage articles in the browser.

Installation

gem install writetheman

Usage

Init

Config the path of your local middleman :

article = Writetheman::Article::Base.new(yourpath)
blog = Writetheman::Blog.new(yourpath)

Init the article :

article.title = title
article.date = date
article.body = body
article.header = header # string
OR article.header_params = {'tags'=>tags}

Operations

Create a new article :

article.create

Update an article :

article.update(oldfilename)

Read an article file

article.load_from_file(filename)
OR article.load_from_title(title, date)

After loading it you have access to the article attributes

puts(article.title)
puts(article.tags)
puts(article.str_date)
puts(article.body)

List articles :

articles = blog.list_articles

To improve

I writed it to use with a html text editor (see my rails admin).
But more often, the html generated by editors is ugly.
I tried to deal with it, but I'm not happy with this code. Also it should be better separated, or moved in another gem.

License

MIT, have fun

writetheman's People

Stargazers

JT5D avatar Michael avatar

Watchers

James Cloos avatar David Tysman 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.