Git Product home page Git Product logo

mkdocs-bibtex's Introduction

testing codecov Language grade: Python

mkdocs-bibtex

A MkDocs plugin for citation management using bibtex.

Setup

Install the plugin using pip:

pip install mkdocs-bibtex

Next, add the following lines to your mkdocs.yml:

plugins:
  - search
  - bibtex:
      bib_file: "refs.bib"
      cite_style: "pandoc"

If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set.

Options

  • bib_file - Name of your bibtex file. Either the absolute path or the path relative to mkdocs.yml
  • bib_dir - Directory for bibtex files to load, same as above for path resolution
  • cite_style - The way you place citations into text: "pandoc" for [@myRef] and "plain" for @myRef
  • bib_command - The command for your bibliography, defaults to \bibliography
  • full_bib_command - The command for your bibliography, defaults to \full_bibliography
  • csl_file - Bibtex CSL file to format the citation with, defaults to None, using a built in plain format instead

Usage

In your markdown files:

  1. Add your citations as you would normally using either "plain" or "pandoc" style
  2. Add in \bibliography or whatever you set your bib_command to where you want your references.
  3. Add in \full_bibliography or whatever you set your full_bib_command to where you want the full set of references. Note: This is not guaranteed to work yet since one issue is the order in which markdown files are processed. Might need to do something using the on_files() event first.
  4. (Optional) Setup csl_file to control the citation text formatting.

mkdocs-bibtex's People

Contributors

shyamd avatar dependabot-preview[bot] avatar timvink avatar fadhleryani 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.