ankitects / ankitects/anki

Add admonitions where appropriate

Open
#5,444 6 comments 3 reactions 1 assignee Claimed by @GithubAnon0000 View on GitHub
docs good first issue
Dominant language
Rust
Stars
30.5k
Forks
3.2k
Avg merge
2d 8h
Merged PRs (30d)
60

Description

In some parts of the docs, we use `` to make things stand out but a warning div can be more proper.

Some examples of where we can use it:

- [ ] [Profile section](https://docs.ankiweb.net/profiles.html#profiles) warns user they cannot sync multiple profiles with one account.

- [ ] The [security warning](https://docs.ankiweb.net/math.html#security-warning) for latex.

- [ ] Look for other things where we can use it.

~~Refer to mdBook docs for how you do it: https://rust-lang.github.io/mdBook/format/mdbook.html#classwarning~~

Actually, we can just use this third-party preprocessor: https://github.com/tommilligan/mdbook-admonish

It gives us more features/flexibility like we can use it to insert FAQs into normal pages (which looks dope if you have seen other sites like that before).

Thoughts, everyone?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.