Giter Club home page Giter Club logo

Comments (1)

florimondmanca avatar florimondmanca commented on August 20, 2024

Hey! Thanks for the develop of mkdocs-click, it'll save me a lot of time on documentation 💚

You're welcome! This was an initial stab at it that fit our own minimal requirements, so happy to discuss any possible enhancements. :-)

If I understand correctly, this is about wrapping sections that contain "Usage" and "Parameters" around a <div>, setting a mkdocs-click specific CSS class there, so that users are able to target that class in a custom CSS file to customize the styling? That sounds pretty sensible.

Right now the only thing that's blocking that is that mkdocs-click is implemented as a Markdown Preprocessor, which means it transforms Markdown lines into Markdown lines, and that result is fed into the HTML renderer further down the line.

So before implementing this, a pre-requisite might be to switch over to BlockProcessor, which works at the HTML element tree level directly. There's a good example of that style in mkautodoc: https://github.com/tomchristie/mkautodoc/blob/master/mkautodoc/extension.py

Not sure if/when we'll get around to that, but that's my analysis for now. Anyone who comes across this is of course very much welcome to take this off if that's something they're interested in. :-)

from mkdocs-click.

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.