Skip to content

Commit

Permalink
Update README to present favored links
Browse files Browse the repository at this point in the history
  • Loading branch information
poliorcetics committed Oct 29, 2020
1 parent 7996165 commit 97e11ba
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ $ cargo intraconv path/to/std/file.rs -a # Applying the changes
$ cargo intraconv path/to/my/file.rs -d # Disambiguate links by prefixing them
# with their rustdoc group ('type@', ...)

$ cargo intravonc path/to/my/file.rs -f # Do not transform favored links to
# intra-doc links (see below for more)

$ cargo intraconv path/to/my/file.rs -q # Do not display changes, only errors
```

Expand All @@ -71,6 +74,12 @@ work. Giving no paths will produce an error.
> Note: `intraconv` will accept any file, no just `.rs` ones: you can use it
> on markdown files that are included as docs in Rust files for example.
### Favored links

By default the crate will transform favored `http(s)://` links to intra-doc
links (like those from [`docs.rs`](https://docs.rs)). To disable this behaviour
use the `-f` (`--no-favored`) flag.

## Known issues

Both intra-doc links and this crate have several known issues, most of which
Expand Down

0 comments on commit 97e11ba

Please sign in to comment.