https://github.com/chomelc/noteautomation

A script to help generate markdown note taking files and convert them to PDF via pandoc.
https://github.com/chomelc/noteautomation

latex markdown pandoc python shell-script

Last synced: 8 days ago
JSON representation

A script to help generate markdown note taking files and convert them to PDF via pandoc.

• Host: GitHub
• URL: https://github.com/chomelc/noteautomation
• Owner: chomelc
• Created: 2020-06-26T14:21:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-21T10:41:19.000Z (almost 4 years ago)
• Last Synced: 2024-12-09T09:52:42.298Z (2 months ago)
• Topics: latex, markdown, pandoc, python, shell-script
• Language: Python
• Homepage:
• Size: 48.8 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NoteAutomation v1.1

A script to help generate markdown note taking files and convert them to PDF via pandoc. 

## Features

- Generate a markdown note taking file, either with a front page (or *header*) or not.

- Compile the markdown file(s) via pandoc to get a PDF file.

## Prerequesites

- Install [Pandoc](https://pandoc.org/installing.html).

- Install [VS Code](https://code.visualstudio.com/download).

## How-to

First, add the following line to your `.bashrc` file:

```shell

source ~//.note_commands.sh

```

Then, you will be able to use the `create-note` and `compile-note` commands:

- `create-note [-h]  ` will generate a markdown file in the specified folder relative to the current path. It will also change the current path to that folder and open the generated file in VSCode.

  - The `-h` option generates a *header* file, aka a front page.

- `compile-note .md` will convert the markdown file to a PDF file.