nextcloud / nextcloud/notes-android

Opening a note that contains a YAML frontmatter changes it into a title

Open
#1,582 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
1.1k
Forks
168
Avg merge
1d 17h
Merged PRs (30d)
31

Description

When a markdown note contains yaml style frontmatter as first lines, as soon as the note is opened, they are changed to a title.

More and more notes app that use local files use markdown and frontmatter for storing metadata. It's also the case of static sites generator that often use static markdown files. I wish we could think about a solution to avoid breaking frontmatter (if that's possible) to allow Nextcloud users to use Notes app as a way to edit those type of files

Steps to reproduce the behavior:

  1. Create a note in Nextcloud that contains any form of frontmatter for example this kind:
---
title: "🧑‍🍳 Recettes" 
modification: 2022-09-21 12:54:36 
tags: 
    - DIY 
    - cuisine
---
  1. Open Notes App and click on "edit" this note
  2. The frontmatter is interpreted as a title and saved as such:
---
## title: "🧑‍🍳 Recettes" modification: 2022-09-21 12:54:36 tags: - DIY - cuisine

Expected behavior
I get it that frontmatter can not be used because of the variety of standards, formats, and metafields used in differents apps or software... but please leave it alone!

Or maybe, then it would be a feature request, add the possibility to enable yaml frontmatter detection?

Smartphone:

  • Nextcloud Notes-Version (android app):
  • F-Droid or Play Store: FDroid
  • Android-Version: 7.0
  • Device: Blackview BV6000

Server

  • Nextcloud version: Nextcloud Hub II (23.0.2)
  • Nextcloud Notes version (server app): 4.3.1

thanks for reading

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source file or test is named in the issue. Reproduce the behavior in the Android Notes editor with the supplied YAML frontmatter, then trace the markdown editing and saving entry points; done means opening and saving the note preserves the frontmatter instead of converting it into a title.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, java
Domain
mobile-dev
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.