Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The task file format #49

Closed
Djyp opened this issue Aug 26, 2023 · 3 comments
Closed

The task file format #49

Djyp opened this issue Aug 26, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@Djyp
Copy link

Djyp commented Aug 26, 2023

It would be an interesting insight to find the file structure the app uses. If its file based then I may think of a way to sync it with Obsidian or any other markdown app.

Maybe just adding an example file with a few tasks would help to see the basic structure?

@BaldissaraMatheus
Copy link
Owner

BaldissaraMatheus commented Aug 26, 2023

The file structure is quite simple, basically every lane you add is a folder and every task is file.

So if you want to see the tasks in Obsidian, first you need to create a folder in your filesystem that will contain your files, then create a Tasks.md docker container with the volume /api/files mounted to that folder you just created, then sync your server with the device you're using Obsidian (I run Obsidian on my phone, so for that purpose I use syncting, but if you use the desktop app you could access this folder through Samba), then open the folder in Obsidian as a vault. The tasks will show up in Obsidian just like any other file, and creating files through there will also show up in Tasks.md just fine.

To show it as example, I just created a new docker container with the volume /mnt/my-files/Tasks-2:/api/files and created a few lanes and one task.

So if your tasks look like this:
image

Your files will look like this:
image
image

And in Obsidian you would see this:
image

@Djyp
Copy link
Author

Djyp commented Aug 27, 2023

This is perfect, you could copy-paste it in your project's documentation as is ! Now I know this format is not made for me ^^ I need to fork the project if I insist on using it.

Btw, it's totally working as is. I often have problems when I try to set up a project but this time it worked like a charm ❤️. I was able to use Tasks.md without tweaks or any hustle

@BaldissaraMatheus
Copy link
Owner

Great! I'm glad I could help. I'll update the documentation with that info as soon as possible

@BaldissaraMatheus BaldissaraMatheus added the documentation Improvements or additions to documentation label Aug 27, 2023
This was referenced Jan 29, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants