Code Monkey home page Code Monkey logo

mdbook-emojicodes's Introduction

mdbook-emojicodes's People

Contributors

blaggacao avatar blyxyas avatar kdheepak avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

mdbook-emojicodes's Issues

Custom emojis just does not work in md headers

Hello @blyxyas,

sorry to bother but I want to report an issue: when you put a custom emoji :example_emoji: in a markdown header it is not rendered. Unfortunately it just work in paragraphs.

Example:

This is a paragraph and :example_emoji: works.

This is a header and :example_emoji: does not work

Thanks in advance for the info you can provide.

Do not render emojis in raw markdown blocks

Thanks for making this plugin!

I would like to add the following section to a developer guide in a mdbook generated documentation:

### `mdbook-emojicodes`

The following raw markdown:

```markdown
I love cats :cat: and dogs :dog:, I have two, one's gray, like a raccoon :raccoon:, and the other one is black, like the night :night_with_stars:.
```

will render as the following:

I love cats :cat: and dogs :dog:, I have two, one's gray, like a raccoon :raccoon:, and the other one is black, like the night :night_with_stars:.

This is how it renders on GitHub:

mdbook-emojicodes

The following raw markdown:

I love cats :cat: and dogs :dog:, I have two, one's gray, like a raccoon :raccoon:, and the other one is black, like the night :night_with_stars:.

will render as the following:

I love cats 🐱 and dogs 🐶, I have two, one's gray, like a raccoon 🦝, and the other one is black, like the night 🌃.

This is how it renders in mdbook:

image

Notice that in the markdown blocks in mdbook it still converts :cat: to 🐱 but it doesn't do that on GitHub.

I think it would be nice if the plugin would leave any code blocks that are titled markdown alone.

Initially I was thinking any code blocks should be left alone but then it wouldn't be possible to use emojicodes in admonish blocks using mdbook-admonish.

Something else to consider is if someone has comments with :tada: in a python code block, should it be rendered as a emoji? Ideally it would be configurable per code block.

Request: Binary releases on github for use with `cargo-binstall`

hello! we currently use mdbook-emojicodes for a documentation site, with deployments handled by github actions. we install the necessary mdbook plugins using https://github.com/taiki-e/install-action, which under the hood uses https://github.com/cargo-bins/cargo-binstall, which just downloads binaries from github releases.

other preprocessors like https://github.com/tommilligan/mdbook-admonish do have binaries for x86 linux in their releases, so the action runner is generally pretty quick. with this preprocessor included, deploy times go from ~10s to ~1m20s, which isn't unmanageable or anything, but it would be very nice if binary releases on tagged versions could be included so the workflow is even faster here

Updating `Nixpkgs`

The nixpkgs distribution of this crate is in version 0.1.3, very outdated. It should be updated.
@blaggacao, wanna give this a try?

Feature Request: custom emoji

Hi, I'm wondering if it's possible to use custom emojis for example contained in a folder at the same level of the md file to convert.

For example, if the containing folder's name is: custom_icons and you have in it some svg emojis like urgent.svg, in the markdown document could be used the emoji shortcode :custom_icons_urgent: (i.e. the shortcode could be composed by the folder name and the image name).

Do you think it's a good idea?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.