danielgtaylor / danielgtaylor/aglio

Anchors for headers with HTML

Open
#162 1 comment 0 reactions 0 assignees View on GitHub
feature request needs work
Dominant language
CoffeeScript
Stars
4.7k
Forks
471
PR merge metrics
No merged PRs in 30d

Description

Using aglio `2.0.4` with olio `1.2.1`, the following

``` markdown
# Group Important Stuff

## Bar

```

leads to the following HTML

``` html

Important Stuff


Bar


```

Though the generated anchors are straight forward, the following seems more natural to me:

``` html

Important Stuff


Bar


```

so that you can refer to `Important Stuff` by `#important-stuff` and to `Bar` by `#header-bar`

In my opinion HTML tags and their attributes should be ignored when generating anchors.

Contributor guide

No contributing guide indexed for this repository

Research direction

Reproduce the issue with the provided aglio 2.0.4 and olio 1.2.1 versions using the two Markdown headings, then locate the anchor-generation entry point. Done means generated IDs and permalink hrefs strip HTML tags and attributes, producing `important-stuff` and `header-bar`.

Written by the indexing model from the issue text.

Assessment

Tech stack
coffeescript
Domain
web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.