Git Product home page Git Product logo

yaml-front-matter-to-bib's Introduction

yaml-header-to-bib


What does this package do?

  • Identifies the YAML section at the start of all markdown files in a directory (recursive)
  • Creates a new bibtex/biblatex file with the parsed references

Rationale

The motivation behind this tool is so that the user can build their own personal notes on each article/text they read on a minimally formatted document such as markdown. Then, they can quickly generate a .bib file from all the articles they have read. The resulting .bib file can then be used as needed e.g. to insert citations in a LaTeX-based dissertation/document.

Format

Below is an imaginary example. The tool recognizes the following fields and turns them to .bib format:

---
title: Testing
author: Test McTest and Test O'Test
journal: Test Journal
year: 1901
volume: 1
number: 1
pages: 500-550 
---

Fields

  • title: The title of the work
  • author: the authors, using their full name First [Middle] Last, with each author separated by and
  • journal: The journal where it was published the work
  • year: The year of publication
  • volume: the volume number of the journal where it was published. Usually the 31 in the AMA-formatted citation: ... 2022;31(4):324-328
  • number: the issue of the journal where it was published. Usually the 4 in the AMA-formatted citation: ... 2022;31(4):324-328. The reason for this is that in the .bib format issue has a different meaning
  • pages: the page number in the format int, or int-int. If the journal reports the article number instead of pages, this number comes here. For journals with page number, it's usually the 324-328 in the AMA formatted citation: ... 2022;31(4):324-328 For journals with article number, it's Usually the 123 in the AMA formatted citation: ... 2022;31(4):123

Installation

Note: Outside of building this repo yourself, currently I only supply a binary for Ubuntu 20 LTS.

To use this tool, simply:

  1. download the latest release binary in the release page
  2. run the binary $ ./yaml-front-matter-to-bib [OPTIONS] --input-directory <INPUT_DIRECTORY>

Current test coverage

yaml-front-matter-to-bib's People

Contributors

andremacedo88 avatar

Watchers

 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.