search

budziq / rust-skeptic

Test your Rust Markdown documentation via Cargo
Apache License 2.0
285 stars 43 forks source link

mdBook integration for rust-skeptic #135

Open tfpk opened 1 year ago

tfpk commented 1 year ago

Hi,

This is more a courtesy notice than an "issue" per se. I just finished an MVP of a program based on rust-skeptic specifically built to integrate with mdBook -- mdbook-keeper.

It is significantly based on rust-skeptic's code. I wanted to use rust-skeptic as a library, but much of your functionality is not exposed, and I needed to modify your code. As such, I wanted to write this for three reasons:

  1. To say thank you very very much for this project!
  2. To ask if there was anything I should do to contribute back to rust-skeptic? I've made sure to note how much my code depends on yours (despite your library not being a dependency); but I'd be happy to upstream anything you're interested in or try and merge our projects to use a library. I didn't do so as a first step because mdbook-keeper is still a POC; but I'd of course be willing to look at it.
  3. Just to let you know the project exists :)

Thanks once again,

~Tom

djc commented 1 year ago

Hey, I'm only doing fairly minimal maintenance on this project (which I inherited maintenance of and don't currently use myself). Might be interesting to see if you can refactor skeptic to it can expose the APIs you need?

tfpk commented 1 year ago

I'll look into it further; especially if anyone ends up using mdbook-keeper and I can justify putting more effort into it.