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

Github italic markdown and other special characters in headers #23

Closed
buhtz opened this issue Dec 23, 2023 · 1 comment · Fixed by #24
Closed

Github italic markdown and other special characters in headers #23

buhtz opened this issue Dec 23, 2023 · 1 comment · Fixed by #24

Comments

@buhtz
Copy link

buhtz commented Dec 23, 2023

I use the Microsoft GitHub style of your toc generator for this content.

## General

### Does _Back in Time_ support full system backups?

foo

### Does _Back in Time_ support backups one cloud storage like OneDrive or Google Drive?

bar

The links for the sub headings (###) do not work because of the _ in the heading. The result is

<!-- TOC start (generated with https://github.com/derlin/bitdowntoc) -->

- [General](#general)
   * [Does _Back in Time_ support full system backups?](#does-_back-in-time_-support-full-system-backups)
   * [Does _Back in Time_ support backups one cloud storage like OneDrive or Google Drive?](#does-_back-in-time_-support-backups-one-cloud-storage-like-onedrive-or-google-drive)

But it should be

<!-- TOC start (generated with https://github.com/derlin/bitdowntoc) -->

- [General](#general)
   * [Does _Back in Time_ support full system backups?](#does-back-in-time-support-full-system-backups)
   * [Does _Back in Time_ support backups one cloud storage like OneDrive or Google Drive?](#does-back-in-time-support-backups-one-cloud-storage-like-onedrive-or-google-drive)

The difference is that the _ should not appear in the anchor link.

This issue is related to a PR in the "Back In Time" project.
bit-team/backintime#1593

EDIT:
Here is another example with an old-school (asscii only) emoticon in the header.


### Which additional features on top of a GUI does BIT provide over a self-configured rsync backup? I saw that it saves the names for uids and gids, so I assume it can restore correctly even if the ids change. Great! :-) Are there additional benefits?
foobar

Wrong:   https://github.com/aryoda/backintime/blob/FAQs/FAQ.md#which-additional-features-on-top-of-a-gui-does-bit-provide-over-a-self-configured-rsync-backup-i-saw-that-it-saves-the-names-for-uids-and-gids-so-i-assume-it-can-restore-correctly-even-if-the-ids-change-great-are-there-additional-benefits
Correct: https://github.com/aryoda/backintime/blob/FAQs/FAQ.md#which-additional-features-on-top-of-a-gui-does-bit-provide-over-a-self-configured-rsync-backup-i-saw-that-it-saves-the-names-for-uids-and-gids-so-i-assume-it-can-restore-correctly-even-if-the-ids-change-great---are-there-additional-benefits
@buhtz buhtz changed the title Github italic markdown in headers Github italic markdown and other special characters in headers Dec 23, 2023
@derlin
Copy link
Owner

derlin commented Jan 3, 2024

Hello @buhtz, and happy new year! Thank you for using bitdowntoc and reporting the issue.

About the italic, I have to check how other systems are behaving, but this is something that needs to be fixed quickly.

For the ASCII emoji though, handling emojis is already quite hard, and I am not sure I want to spend yet another weekend on this (see my article. I hope this is an edge case that does not happen too often?

Will keep you posted, thanks again for the report!

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

Successfully merging a pull request may close this issue.

2 participants