search

orium / cargo-rdme

Cargo command to create the README.md from your crate's documentation
Mozilla Public License 2.0
126 stars 5 forks source link

`--intralinks-strip-links` not doing anything? #228

Closed virtualritz closed 5 months ago

virtualritz commented 5 months ago

Maybe I misunderstand the meaning of the CLI option.

I have this in my lib.rs

Use [`bar()`](Foo::bar) to baz.

With --intralinks-strip-links I would expect to get this in my README.md:

Use `bar()` to baz.

But I get:

Use [`bar()`](Foo::bar) to baz.

I.e. it seems the flag doesn't do anything?

orium commented 5 months ago

Currently cargo-rdme only supports links of the format [⋯](crate::⋯), so those are currently not considered intralinks. If you write [bar()](crate::Foo::bar) it should work.

This is another limitation that will be removed once #177 is done.

orium commented 5 months ago

Closing as a dup of #151.