Trying to solve a good first issue in hedgedoc

GGH-WeyboZetO · April 8, 2023, 5:23pm

My version of HedgeDoc is: 1.x

What I expected to happen:
I’m currently trying to solve this issue in gitlab:

github.com/hedgedoc/hedgedoc

<details> tags mess up scrolling in split view

opened 06:48PM - 07 Feb 23 UTC

ptomato

type: bug priority: 3. low

### Description Adding `<details>` tags to a note, in order to collapse secti…ons, makes the scrolling in the split view work incorrectly. When scrolling in the right (view) pane, the left (editor) pane will jump to the end of the document. ### Steps to reproduce Here is a sample note which I used to reproduce the issue on the demo instance on hedgedoc.org: ```markdown # Title ## A list of numbers - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 <details> <summary>More numbers</summary> - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 </details> ``` To see the issue: 1. Paste the above markdown into a note. 2. Go to the "Both" split view. 3. With the mouse over the right (view) pane, scroll down (with a scroll wheel or touchpad gesture or whatever.) 4. Around when "26" scrolls into view on the right pane, the left pane scrolls all the way to the bottom of the document, making the two panes display entirely different sections of the document. (This happens regardless of whether the `<details>` element is collapsed or expanded in the right pane.) 5. Also note the markdown within the `<details>` element isn't syntax-highlighted, despite there being a blank line before and after all the HTML tags. Autocomplete of list bullets doesn't work inside the `<details>` element. ### Expected behaviour The left and right panes should display the same part of the document, as they do when no `<details>` element is present. Additionally, I'd expect that editing markdown within the `<details>` element should work like editing markdown outside of it does, as long as there are blank lines before and after HTML elements — it should be syntax highlighted and autocomplete of list bullets should work. ### Logs _No response_ ### Config _No response_ ### Your Setup - Host OS: (N/A, reproduced on demo instance) - NodeJS version: (N/A, reproduced on demo instance) - HedgeDoc version: 1.9.6 + unreleased ### Additional context _No response_

or an easy first issue if you have anything to give to me ty.

What actually happened:
I don’t know where exatly is implemented the auto-scrolling method in the code.

I already tried:
searching with vscode

thank you for reading me.

DerMolly · April 9, 2023, 7:24pm

Hey @GGH-WeyboZetO,

I understand your question like this: you are trying to fix this in the HedgeDoc 1.x codebase and need assistance with where to find the code that handles this.

Assuming this is your question, please be aware that

We don’t really work on non-critical bugfixes for HD1 anymore, because as stated in the README this version is in maintenance-only mode, so even if you provide a PR that fixes this problem we won’t necessarily merge it anytime soon.
The HD1 code is fairly messy and very entangled. Changes in one part of the code may yield to unexpected consequences elsewhere. We don’t really recommend working with that if not absolutely necessary.

If you read this and still want to work on this afaik the scroll-sync code is here.

If you just want to work on HedgeDoc 2.0, it’s currently a bit complicated as we try to finish everything for a first alpha release, but something that should be rather easy - complexity wise - would be the different auth providers that are still missing from HedgeDoc. See this issue.

Greetings
DerMolly

GGH-WeyboZetO · April 10, 2023, 10:22am

Hello, I have seen that bug from 1.x was not fixed for the v2.0 thus I thought It would be relevant since fixing it on v1.x would be the same fix for v2.0.

Although I would be glad to help for that HedgeDoc 2.0 issue but I’m struggling to start the version on the develop branch which is the v2.0 if I understood correctly?

I’m trying to follow theses instructions for 1.x: Manual Installation - HedgeDoc
but the bin/setup is not recognized my terminal is telling me “no such a directory or file”, I guess it’s because the path is wrong? But following theses instructions I should just have to go in the project directory and run that command.

Can you give me a " Manual Installation" for the v2.0 that is on develop branch?

Thank you.

DerMolly · April 10, 2023, 6:47pm

Hello, I have seen that bug from 1.x was not fixed for the v2.0 thus I thought It would be relevant since fixing it on v1.x would be the same fix for v2.0.

HD 2 is full rewrite of the software. There is nothing that can be fixed in 1.x that would carry over to 2.0

Although I would be glad to help for that HedgeDoc 2.0 issue but I’m struggling to start the version on the develop branch which is the v2.0 if I understood correctly?

Yes, develop holds the 2.0 code.

I’m trying to follow theses instructions for 1.x: Manual Installation - HedgeDoc
but the bin/setup is not recognized my terminal is telling me “no such a directory or file”, I guess it’s because the path is wrong? But following theses instructions I should just have to go in the project directory and run that command.

Can you give me a " Manual Installation" for the v2.0 that is on develop branch?

Sure thing. Have a look here

Thank you.

You’re welcome.

GGH-WeyboZetO · April 10, 2023, 9:18pm

Hey thank you for your response I think I almost managed to run v2.0 properly but I’m still having some problems, I’m not sure but I think I managed to launch the v2.0 version with yarn start:dev (backend) and yarn start:dev:mock (frontend) separatly but when i’m trying to start both with caddy it’s not working…

I tried to install caddy with what I found on install caddy website (sorry I can’t send many links since i’m new user )
But when i’m running “run caddy” pages seems not working.

And I tried to install caddy into dev-reverse-proxy with this:

wget -O caddy https://github.com/caddyserver/ntlm-transport
chmod +x caddy
./caddy

But in my terminal I get this error when trying to execute caddy:

./caddy: 9: Syntax error: newline unexpected

Can you help me for caddy installation?

Plus…

Can I ask you where is the “synchroll.js” implementation from v1.x in v2?

Which script (.js) are executed when we load that page?
this

How can I open all “details” box in the right part of “edit-mode” I thought of using this but it seems not working or maybe i’m using it in the wrong script (.js) file:

// Get all the details elements on the page
const detailsElements = document.getElementsByTagName(‘details’);
// Loop through each details element and set the “open” attribute to true
for (let i = 0; i < detailsElements.length; i++) {
detailsElements[i].setAttribute(‘open’, true);
}

Thank you.