aai-institute / continuiti

Learning function operators with neural networks.

GNU Lesser General Public License v3.0

19 stars 3 forks source link

Doc: Anchor Underline #81

Closed JakobEliasWagner closed 6 months ago

JakobEliasWagner commented 6 months ago

Doc: Anchor Underline

Description

This pr removes underscores between badges in the README.md file in the browser.

The rendered badges change from

drawing

to

drawing

Which issue does this PR tackle?

Currently with using html anchors in the README file renders an underscore between the badges. This is caused by the anchor underlining its content. For badges the underline is rendered after the badge itself, creating lines. A screenshot of this can be seen in #80.
Style attribute is not supported by github (change to markdown format necessary).
Fixes #80.

How does it solve the problem?

Changes the html anchor to an equivalent markdown implementation.

How are the changes tested?

Hyperlinks and badges are rendered the same and point to the same locations.

Checklist for Contributors

[x] Scope: This PR tackles exactly one problem.
[x] Conventions: The branch follows the feature/title-slug convention.
[x] Conventions: The PR title follows the Bugfix: Title convention.
[x] Coding style: The code passes all pre-commit hooks.
[x] Documentation: All changes are well-documented.
[x] Tests: New features are tested and all tests pass successfully.
[x] Changelog: Updated CHANGELOG.md for new features or breaking changes.
[x] Review: A suitable reviewer has been assigned.

Checklist for Reviewers:

[x] The PR solves the issue it claims to solve and only this one.
[x] Changes are tested sufficiently and all tests pass.
[x] Documentation is complete and well-written.
[x] Changelog has been updated, if necessary.