GithubHelp home page GithubHelp logo

Escape html tag in equations about doc-gen4 HOT 3 CLOSED

xubaiw avatar xubaiw commented on July 22, 2024
Escape html tag in equations

from doc-gen4.

Comments (3)

xubaiw avatar xubaiw commented on July 22, 2024

Screenshot from earlier 7d43c83 build.
ζˆͺ屏2022-02-19 δΈ‹εˆ11 11 24

from doc-gen4.

hargoniX avatar hargoniX commented on July 22, 2024

The small stuff is not generated by doc-gen itself @xubaiw, the issue here is that your input files such as UCD/NameList.txt in your Unicode package do contain HTML tags, since you are statically including this into your code the generated equations will in turn contain these tags as well which causes this visual bug.

This basically comes down to: If your equations contain HTML in a way that the browser can interpret as syntactically correct your stuff will be represented in a wrong way. I'm guessing this can be fixed by escaping stuff here but I'm entirely unsure how to do this.

from doc-gen4.

hargoniX avatar hargoniX commented on July 22, 2024

An alternative could be a an attribute that explicitly tells doc-gen to not generate equations about the declaration that is about to follow. This would also be reasonable in some regions of Mathlib where the equations that are generated are just insanely huge and not helpful at all like e.g. here: https://leanprover-community.github.io/mathlib4_docs/Mathlib/Data/BinaryHeap.html#BinaryHeap.heapifyDown

from doc-gen4.

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.