Skip to content

Latest commit

 

History

History
108 lines (63 loc) · 4.71 KB

README.md

File metadata and controls

108 lines (63 loc) · 4.71 KB
Raw

day-one-to-obsidian-converter

Integrate Merge Release Renew

Code Coverage Type Coverage

Latest Stable Version Total Downloads Monthly Downloads

This project provides a composer package with a console command for converting DayOne journals to Obsidian notes.

Installation

Run

composer require ergebnis/day-one-to-obsidian-converter

Usage

Run

php bin/day-one-to-obsidian-converter <day-one-directory> <obsidian-vault-directory>

The command will

  • look for JSON files in <day-one-directory>
  • convert JSON files that match the JSON Schema in resource/day-one/schema.json to Markdown files in <obsidian-vault-directory>

Ideally, the <obsidian-vault-directory> should not exist yet.

Demo

Run

git clone git@github.com:ergebnis/day-one-to-obsidian-converter.git

to clone this repository.

Run

composer install

to install dependencies with composer.

Run

php bin/day-one-to-obsidian-converter demo/day-one demo/obsidian

to see the converter in action.

Changelog

The maintainers of this project record notable changes to this project in a changelog.

Contributing

The maintainers of this project suggest following the contribution guide.

Code of Conduct

The maintainers of this project ask contributors to follow the code of conduct.

General Support Policy

The maintainers of this project provide limited support.

You can support the maintenance of this project by sponsoring @localheinz or requesting an invoice for services related to this project.

PHP Version Support Policy

This project supports PHP versions with active and security support.

The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.

Security Policy

This project has a security policy.

License

This project uses the MIT license.

Credits

This converter is inspired by quantumgardener/dayone-to-obsidian.

The list of non-printable characters for the RemoveNonPrintableCharacters text processor is obtained from PhpCsFixer\Fixer\Basic\NonPrintableCharacterFixer, originally created by Ivan Borzenkov.

The files in demo/day-one/ are taken from Importing data to Day One: Details about the import file types, and can be downloaded here

Social

Follow @localheinz and @ergebnis on Twitter.