ergebnis / day-one-to-obsidian-converter
Provides a console command for converting DayOne journals to Obsidian notes.
Installs: 13
Dependents: 0
Suggesters: 0
Security: 0
Stars: 8
Watchers: 3
Forks: 0
Open Issues: 1
Type:project
Requires
- php: ~8.1.0 || ~8.2.0 || ~8.3.0
- ergebnis/json-schema-validator: ^2.0.0
- symfony/console: ^6.4.1
- symfony/filesystem: ^6.4.0
- symfony/yaml: ^6.4.0
Requires (Dev)
- ergebnis/composer-normalize: ^2.29.0
- ergebnis/data-provider: ^3.2.0
- ergebnis/license: ^2.4.0
- ergebnis/php-cs-fixer-config: ^6.14.0
- ergebnis/phpunit-slow-test-detector: ^2.7.0
- fakerphp/faker: ^1.23.0
- infection/infection: ~0.27.9
- phpunit/phpunit: ^10.5.2
- psalm/plugin-phpunit: ~0.18.4
- rector/rector: ~0.18.12
- roave/backward-compatibility-check: ^8.4.0
- vimeo/psalm: ^5.17
This package is auto-updated.
Last update: 2024-12-06 08:02:25 UTC
README
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.