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

Markdown syntax causing output issues and formatting errors #92

Open
memN0ps opened this issue Jun 24, 2023 · 4 comments
Open

Markdown syntax causing output issues and formatting errors #92

memN0ps opened this issue Jun 24, 2023 · 4 comments

Comments

@memN0ps
Copy link

memN0ps commented Jun 24, 2023

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

  • Theme: Archie
  • Version: Latest version

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

@athul
Copy link
Owner

athul commented Jun 25, 2023

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
Copy link
Author

memN0ps commented Jun 26, 2023

Example 1:

image
image

Example 2:

image
image

@athul
Copy link
Owner

athul commented Jun 26, 2023

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
Copy link
Author

memN0ps commented Jun 26, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants