Comments (1)
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 inmake.jl
if you need that.
from documenter.jl.
Related Issues (20)
- Switching versions resets to the default page HOT 3
- LoadError: `makedocs` encountered an error [:missing_docs] -- terminating build before rendering. HOT 7
- Links to collapsed pages end up off-screen
- Documenter might not be expanding the example blocks in docstrings HOT 2
- Handling of ANSI foreground/background inversion is incorrect HOT 3
- Use AnnotatedIOBuffer + StyledStrings for handling ANSI codes. HOT 2
- ERROR: LoadError: PCRE compilation error: regular expression is too large HOT 9
- Cross reference between modules HOT 3
- Use mathml as an alternative `mathengine` HOT 3
- Anchors for admonitions
- How to create custom badges HOT 2
- Cannot find level-three cross-references HOT 6
- Got a `If you are seeing this warning/error after upgrading Documenter and this used to work`
- Doctest fix versus exceptions
- Allow setting a global `DocTestSetup` block for all `.md` files in one place
- Make search_index a JSON file
- Alternative admonition syntax?
- Support for external parsers like CommonMark HOT 2
- Profiling docs build times HOT 3
- Not Matching Versions for Subpackage Version Tags HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from documenter.jl.