Giter Club home page Giter Club logo

Comments (1)

mortenpi avatar mortenpi commented on June 11, 2024

So, I largely disagree with the points above.

  • By having users recompile the CSS all the time, we'd be more exposed to attacks against the dependency tree. While that could also affect us here, (1) the attack surface is fixed and much-much smaller, and (2) there is at least some review of the compiled CSS, and the CI check is pretty robust in my opinion.

  • Compiling the CSS is not computationally expensive, but you have do deal with additional dependencies. And while Sass.jl would probably be fine as a Documenter dependency nowadays, we may well have to move away from libsass to calling Dart code. (https://sass-lang.com/libsass/ piever/Sass.jl#27)

  • One thing I do half-agree on is that the generated files are annoying bloat in the repo, although it's not an issue in practice in my experience. We have a .gitattributes file that declares these files generated, so tooling should take that into account.

    In my mind, the correct way to handle the compiled CSS would be via Artifacts. But I have no clear idea how to manage that end-to-end since, in general, we'd need different artifacts for each commit. We could potentially maintain the theme in a separate repository, but that makes working on any front-end changes quite a bit more annoying.

  • One bonus for compiling the theme during makedocs would be that handling custom themes would be slightly easier. But it's also not hard to import DocumenterTools in make.jl if you need that.

from documenter.jl.

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.