Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ergebnis/day-one-to-obsidian-converter
📓 Provides a composer package with a console command for converting DayOne journals to Obsidian notes.
https://github.com/ergebnis/day-one-to-obsidian-converter
converter day-one obsidian
Last synced: 3 months ago
JSON representation
📓 Provides a composer package with a console command for converting DayOne journals to Obsidian notes.
- Host: GitHub
- URL: https://github.com/ergebnis/day-one-to-obsidian-converter
- Owner: ergebnis
- License: mit
- Created: 2022-07-25T17:51:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T07:43:53.000Z (9 months ago)
- Last Synced: 2024-05-01T11:41:17.908Z (9 months ago)
- Topics: converter, day-one, obsidian
- Language: PHP
- Size: 118 MB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
- project-awesome - ergebnis/day-one-to-obsidian-converter - 📓 Provides a composer package with a console command for converting DayOne journals to Obsidian notes. (PHP)
README
# day-one-to-obsidian-converter
[](https://github.com/ergebnis/day-one-to-obsidian-converter/actions)
[](https://github.com/ergebnis/day-one-to-obsidian-converter/actions)
[](https://github.com/ergebnis/day-one-to-obsidian-converter/actions)
[](https://github.com/ergebnis/day-one-to-obsidian-converter/actions)
[](https://codecov.io/gh/ergebnis/day-one-to-obsidian-converter)
[](https://shepherd.dev/github/ergebnis/day-one-to-obsidian-converter)
[](https://packagist.org/packages/ergebnis/day-one-to-obsidian-converter)
[](https://packagist.org/packages/ergebnis/day-one-to-obsidian-converter)
[](https://packagist.org/packages/ergebnis/day-one-to-obsidian-converter)
This project provides a [`composer`](https://getcomposer.org) package with a console command for converting [DayOne](https://dayoneapp.com) journals to [Obsidian](https://obsidian.md) notes.
## Installation
Run
```sh
composer require ergebnis/day-one-to-obsidian-converter
```
## Usage
Run
```sh
php bin/day-one-to-obsidian-converter
```
The command will
- look for JSON files in ``
- convert JSON files that match the JSON Schema in [`resource/day-one/schema.json`](resource/day-one/schema.json) to Markdown files in ``
Ideally, the `` should not exist yet.
## Demo
Run
```sh
git clone [email protected]:ergebnis/day-one-to-obsidian-converter.git
```
to clone this repository.
Run
```sh
composer install
```
to install dependencies with `composer`.
Run
```sh
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](CHANGELOG.md).
## Contributing
The maintainers of this project suggest following the [contribution guide](.github/CONTRIBUTING.md).
## Code of Conduct
The maintainers of this project ask contributors to follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
## General Support Policy
The maintainers of this project provide limited support.
You can support the maintenance of this project by [sponsoring @localheinz](https://github.com/sponsors/localheinz) or [requesting an invoice for services related to this project](mailto:[email protected]?subject=ergebnis/day-one-to-obsidian-converter:%20Requesting%20invoice%20for%20services).
## PHP Version Support Policy
This project supports PHP versions with [active and security support](https://www.php.net/supported-versions.php).
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](.github/SECURITY.md).
## License
This project uses the [MIT license](LICENSE.md).
## Credits
This converter is inspired by [`quantumgardener/dayone-to-obsidian`](https://github.com/quantumgardener/dayone-to-obsidian).
The list of non-printable characters for the [`RemoveNonPrintableCharacters`](src/Inside/Domain/DayOneToObsidian/Text/RemoveNonPrintableCharacters.php) text processor is obtained from [`PhpCsFixer\Fixer\Basic\NonPrintableCharacterFixer`](https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/v3.10.0/src/Fixer/Basic/NonPrintableCharacterFixer.php#L58-L64), originally created by [Ivan Borzenkov](https://github.com/ivan1986).
The files in [`demo/day-one/`](demo/day-one/) are taken from [Importing data to Day One: Details about the import file types](https://dayoneapp.com/guides/settings/importing-data-to-day-one/#details-about-the-import-file-types-), and can be downloaded [here](https://bloom-documentation.s3.amazonaws.com/JSON+Export+example.zip)
## Social
Follow [@localheinz](https://twitter.com/intent/follow?screen_name=localheinz) and [@ergebnis](https://twitter.com/intent/follow?screen_name=ergebnis) on Twitter.