athul / archie

A minimal Hugo Theme
https://athul.github.io/archie
MIT License
977 stars 299 forks source link

Markdown syntax causing output issues and formatting errors #92

Open memN0ps opened 1 year ago

memN0ps commented 1 year ago

Overview:

When using certain markdown syntax in the Archie theme, the output is being affected in unexpected ways. This issue aims to address the problems related to specific markdown elements and formatting inconsistencies.

Steps to Reproduce:

  1. Add the following markdown syntax:
    1. `v3[272]`
    2. [int execve(const char *pathname, char *const argv[], char *const envp[]);](https://man7.org/linux/man-pages/man2/execve.2.html)
    3. `CR4.VMXE[bit 13]`
  2. Observe the output for the above markdown syntax and note any inconsistencies or rendering issues.
  3. Additionally, insert two new lines between bullet points as follows:

    * https://github.com/
    
    * https://github.com/
  4. Verify the output for the updated markdown syntax and identify any unexpected behavior or formatting errors.

Current Behavior:

The current behavior of the Archie theme when rendering the markdown syntax mentioned above is causing the following issues:

  1. The text v3[272] is not being displayed correctly.
  2. The hyperlink [int execve(const char *pathname, char *const argv[], char *const envp[]);](https://man7.org/linux/man-pages/man2/execve.2.html) is not rendering properly.
  3. The text CR4.VMXE[bit 13] is being displayed incorrectly.
  4. Two new lines between bullet points are not producing the expected line spacing in the rendered markdown output.

Expected Behavior:

The Archie theme should handle the specified markdown syntax consistently and accurately, ensuring the correct rendering of the content. The expected behavior is as follows:

  1. The text v3[272] should be displayed correctly.
  2. The hyperlink [int execve(const char *pathname, char *const argv[], char *const envp[]);](https://man7.org/linux/man-pages/man2/execve.2.html) should render properly.
  3. The text CR4.VMXE[bit 13] should be displayed correctly.
  4. Two new lines between bullet points should result in appropriate line spacing in the rendered markdown output.

Environment

Please let me know if you need any further information or clarification regarding this issue.

athul commented 1 year ago

Hi,

I tried to replicate the issues but couldn't replicate the issues you mentioned.

Screenshot 2023-06-25 at 3 13 27 PM Screenshot 2023-06-25 at 3 13 51 PM

Would be great if you could add some screenshots.

memN0ps commented 1 year ago

Example 1:

image image

Example 2:

image image

athul commented 1 year ago

So markdown is weird when using and rendering []. Can you try using a \ before the [ and ]

Eg: CR4.VMXE\[bit 13\]

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#ignoring-markdown-formatting

memN0ps commented 1 year ago

This is weird, because it gets rendered on GitHub markdown preview just fine but or when I use another Hugo theme but not Archie.

image