Git Product home page Git Product logo

Comments (12)

jacobdalamb avatar jacobdalamb commented on September 15, 2024 1

And does it support styling/highlighting nushell language syntax?

Yes. https://github.com/shikijs/textmate-grammars-themes/blob/main/packages/tm-grammars/README.md

from nushell.github.io.

fdncred avatar fdncred commented on September 15, 2024 1

I personally wouldn't mind seeing a PR but it would have to:

  1. be as easy or easier to manage than what we have now
  2. look as good or better than what we have now
  3. translations would need to work as good or better than what we have now
  4. @hustcer would need to approve of it since he manages a lot of the site for us now (we'd have to have other core-team members approve too in order to move to it, but not really needed for a preview)
  5. we'd also need a way to preview it somehow

from nushell.github.io.

hustcer avatar hustcer commented on September 15, 2024 1

@jacobdalamb

There are two things I most care about:

  1. Build speed, we have lots of docs now, the build speed is not fast enough, in the future we also intend to support multiple versions and the build speed requirements are higher. We do not support multiple versions also due to the slow build speed.
  2. The new approach need to support multiple versions, which is especially important after version v1.0. We may have docs for v1 and v1.1, etc. at the same time.
    You can try to solve these two points with Starlight.

from nushell.github.io.

fdncred avatar fdncred commented on September 15, 2024

we're always interested in making things better but it's not clear how that is true with starlight.

from nushell.github.io.

jacobdalamb avatar jacobdalamb commented on September 15, 2024

starlight

I can I think of a few improvements on top of the ones I mentioned. Starlight comes with copy and paste buttons for code blocks, "gives you built-in frontmatter validation with TypeScript type-safety", built-in components, and in my opinion custom block containers (tip, caution, and note) that are visually styled better.

from nushell.github.io.

fdncred avatar fdncred commented on September 15, 2024

And does it support styling/highlighting nushell language syntax?

from nushell.github.io.

fdncred avatar fdncred commented on September 15, 2024

It would be nice to have something that supports tree-sitter-nu too at some point. That grammar is coming along nicely.

from nushell.github.io.

hustcer avatar hustcer commented on September 15, 2024

There are tons of SSG tools, and I don't think they have great advantage over Rspress, especially talking about building performance. BTW: Rspress adds shiki plugin support recently.
Glad if you prove me wrong.
Related: #1126

from nushell.github.io.

jacobdalamb avatar jacobdalamb commented on September 15, 2024

There are tons of SSG tools, and I don't think they have great advantage over Rspress, especially talking about building performance. BTW: Rspress adds shiki plugin support recently. Glad if you prove me wrong. Related: #1126

Another great alternative to the current docs. Both are good.

from nushell.github.io.

jacobdalamb avatar jacobdalamb commented on September 15, 2024

It would be nice to have something that supports tree-sitter-nu too at some point. That grammar is coming along nicely.

Would you be interested in a PR to see what the site would look like using Starlight?

from nushell.github.io.

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.