Code Monkey home page Code Monkey logo

Comments (3)

TheOtterlord avatar TheOtterlord commented on May 24, 2024 1

The markdown guide explains this (see Customizing a plugin. I did notice the reference is presented first in the search results, which I'm guessing is what lead you to reference? We could 100% look at adding a plugin with options or a link to the example.

from docs.

nibble0101 avatar nibble0101 commented on May 24, 2024

The markdown guide explains this (see Customizing a plugin. I did notice the reference is presented first in the search results, which I'm guessing is what lead you to reference? We could 100% look at adding a plugin with options or a link to the example.

Yes, I ended up in the reference via search. An example plugin with options or a link to the existing example will make things a lot easier.

from docs.

sarah11918 avatar sarah11918 commented on May 24, 2024

Interestingly when I searched, I did not get reference first but did get the upgrade guides first, then the Learn, and then reference!

What if we just update the example on the configuration reference page, which currently shows remarkToc anyway, and just add any old custom value, e.g. the one on the Markdown page:

remarkPlugins: [ [remarkToc, { heading: "contents"} ] ],

We try to keep the configuration page as concise as possible, but this at least is a visual clue to point people in the right direction without needing a ton of words to clutter the page.

Would be happy if someone would like to make a PR to that effect! The change to make would be on this line

from docs.

Related Issues (20)

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.