awesome-mdbook icon indicating copy to clipboard operation
awesome-mdbook copied to clipboard

Add selected preprocessors, e.g. for emoji conversion

Open almereyda opened this issue 4 years ago • 6 comments

Finding this list, I was surprised to only find awesome mdbooks. My expectation would have been, that we also find useful preprocessors used in the wild.

  • Some can be found via https://github.com/search?q=mdbook+preprocessor
  • https://github.com/topics/mdbook-plugins
  • https://crates.io/keywords/mdbook

Do we know other preprocessors "out there", eventually not on GitHub, that could help us and others, worth mentioning here?

almereyda avatar Aug 09 '21 14:08 almereyda

Nice preprocessors that are not mentioned by this list, are for example:

  • https://github.com/Michael-F-Bryan/mdbook-linkcheck
  • https://github.com/dylanowen/mdbook-graphviz

I'm especially looking for emoji conversion, as done with https://github.com/shonfeder/emojitsu#use-with-mdbook, and researched in https://github.com/mwunsch/rumoji/issues/52#issuecomment-890247251. But that can also become a new crate, based on

almereyda avatar Aug 09 '21 14:08 almereyda

The research in https://lab.allmende.io/yala/mdbook-emojis/-/snippets/418 now led to https://crates.io/crates/mdbook-emojis

Now could be a good time to select a few preprocessors for listing here, and to contribute a PR that implements this change.

almereyda avatar Aug 10 '21 00:08 almereyda

I’m into it. The original idea was less about inputs for mdbook (plugins) but outputs (the books) themselves

a bookshelf of mdbooks if you will. I was enjoying reading them but hadn’t com across an index of them for discovery so I started this

softprops avatar Aug 10 '21 02:08 softprops

Nice. I like the awesome-mdbook-shelf idea.

In case you would like to diverge paths here, and keep that separate distinction, why not shift this project's identifier over a little, and have an awesome-mdbooks list, too?

I'd then be willing to fabricate an awesome-mdbook list from the available sources, that would be more technically oriented.

Else I'm always happy to keep content + form together, rather than apart, and contribute the findings here. Along the way, we might need to introduce categories already, too. #7

This work will be roughly based on these commits:

  • https://github.com/almereyda/awesome-starred/commit/f05efc24d71af00166e089a12d910fa5b0bf5b33
  • https://github.com/almereyda/awesome-starred/commit/c2067e72b322ffdbcdce7fb05a733ab086d87520

and some more from foraging the GitHub topic, search, my previous stars and within the Crates as well.

almereyda avatar Aug 10 '21 23:08 almereyda

Whatever works for you is fine. I’m happy to accept pull requests

softprops avatar Aug 11 '21 01:08 softprops

Ok, that can happen some time soon'ish.

As a note to myself, we could also like to provide an mdBook template to the collection of GitLab CI/CD examples in https://gitlab.com/pages

There are plenty of GitHub Actions examples in some of the packages identified above.

almereyda avatar Aug 12 '21 12:08 almereyda