Code Monkey home page Code Monkey logo

field_notes's Introduction

Field Notes Microbloggy Application

Field Notes

This repo contains a simple ruby web application for displaying "field notes". Its designed to be a companion during your day to day work to record and catalogue different thoughts on resources. You can find out more about this repo and its code on my blog.

Testing

$ make test

Production

$ bin/server -p $PORT

Developing

$ script/dev-server

Writing Notes

The application is vaguely inspired by Jekyll without out all the fancy case handling. Each note is a single markdown file. The file name should match the format YYYY-MM-DD-anything_else.md. Inside the file set the tag via YMAL frontmatter. Here's an example:

---
tag: article
---

I read this awesome [article](http://example.com) and it tought me
so much!

The code will match the dates (via the YYY-MM-DD) and the appropriate tag to create a nice monthly view grouped by tag. The content is parsed with redcarpet with useful extensions enabled.

Taking Notes

The field notebook is supposed to be by yourside whenever you need it. Most work is done at a computer these days. So we have the technology to create a simple script that can live with us in the shell. This will make it easy to jot down notes in the editor--especially useful if you spend the whole day in the terminal. There is an example in util/fn. I've only tested in OSX (which uses BSD commands) so GNU folks may need to update it. Once setup you'll get something like this:

$ fn type as many things as you want here
$ ... now write what in EDITOR ...

The "type as many things as you want here" is sanitized and joined with a properly formatted date and put into the property directory. Next just commit the changes and push how you like.

field_notes's People

Contributors

ahawkins avatar

Stargazers

Eduardo Mello avatar Nogweii avatar Mike Guterl avatar

Watchers

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