GithubHelp home page GithubHelp logo

some restructuring about mathjax-docs HOT 15 CLOSED

mathjax avatar mathjax commented on July 20, 2024
some restructuring

from mathjax-docs.

Comments (15)

dpvc avatar dpvc commented on July 20, 2024

That all sounds good. Do you need me to do anything about this, or are you planning to make the changes?

from mathjax-docs.

pkra avatar pkra commented on July 20, 2024

Ok, it's settled then. I'll do it when I find some time to spare.

from mathjax-docs.

pkra avatar pkra commented on July 20, 2024

I've created a test branch with the new RTD theme at http://docs.mathjax.org/en/new_theme/index.html

Looking good to me.

from mathjax-docs.

pkra avatar pkra commented on July 20, 2024

It turns out I misunderstood the redirecting part.

What we can do is have docs.mathjax.org redirect to any version/branch we want. That leaves the question what to do with latest. We could stop building latest entirely but that would bring back the problem we solved with canonical links to latest -- page rank of some specific version will dominate.

So I would propose to leave the branches and RTD setup as they are. Switching back to theme = default will at least simplify the merging of latest and N.m-latest which triggered this issue...

from mathjax-docs.

pkra avatar pkra commented on July 20, 2024

For a live built see http://pkra-mathjax-docs.readthedocs.org/en/latest/

from mathjax-docs.

pkra avatar pkra commented on July 20, 2024

@dpvc can you review these? Then I can start working on the docs for 2.4

from mathjax-docs.

dpvc avatar dpvc commented on July 20, 2024

it looks good overall. But there are two things that bother me. First, in the left-hand sidebar, all the links from the home page appear, but not separated into their categories. I think it is hard to read these without the separations by heading that is part of the home page. I'm not sure you can do anything about it or not.

The other thing is that the alphabetical list of LaTeX commands doesn't format well (for me in Safari) due to the bold monospaced font. Apparently the bolding is being done algorithmically rather than via an actual font, and that makes it no longer monospaced, so the second column does not align. Perhaps there is a better way to handle that?

from mathjax-docs.

pkra avatar pkra commented on July 20, 2024

Ok, I'll look into these. (When we spoke, I thought you meant the rendering of :: describe blocks which are used for TeX examples like \bbox[options]{math}).

I'll look into the sidebar and TeX-command list thing.

from mathjax-docs.

dpvc avatar dpvc commented on July 20, 2024

No, I just meant the alphabetical listing, which has a second column that indicates the extension to load for that command. The second column is not aligning properly for me.

Davide

On May 8, 2014, at 12:55 PM, Peter Krautzberger wrote:

Ok, I'll look into these. (When we spoke, I thought you meant the rendering of :: describe blocks which are used for TeX examples like \bbox[options]{math}).

I'll look into the sidebar and TeX-command list thing.


Reply to this email directly or view it on GitHub.

from mathjax-docs.

pkra avatar pkra commented on July 20, 2024

Hm. I think I see that. Do you mean all the bracketed ones? I think the problem with those is in the source.

from mathjax-docs.

dpvc avatar dpvc commented on July 20, 2024

No, what I mean is this:

alignment

You may not see it, because I think it is font dependent. The font-family is set to "Incosolata","Consolata","Monaco",monospace, and I don't have the first two, so am getting Monaco. This does not have a bold variant, so the bold is generated algorithmically (by adding a shifted version of the original -- poor-man's-bold). That means that the width is not the same as the unbold Monaco, and so the longer control sequences take more pixels than the shorter ones, and so the spacing of the second column is off. Admittedly, that is an error in Safari's rendering, but I'm not sure the bold is worth it. I also checked with Firefox, and it has a similar issue.

from mathjax-docs.

dpvc avatar dpvc commented on July 20, 2024

PS, the bracketed ones are supposed to be one character to the left, so the extension name is the alignment point.

from mathjax-docs.

pkra avatar pkra commented on July 20, 2024

Ah, ok. I don't see that on my system. I'll create an issue.

from mathjax-docs.

pkra avatar pkra commented on July 20, 2024

Would you be ok with merging this for the time being? Or would you consider those two issues as blocking?

from mathjax-docs.

dpvc avatar dpvc commented on July 20, 2024

Sure, go ahead. The sidebar is the one that bothers me the most, and I hope it can be improved in the future.

from mathjax-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.