Comments (12)
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.
I personally wouldn't mind seeing a PR but it would have to:
- be as easy or easier to manage than what we have now
- look as good or better than what we have now
- translations would need to work as good or better than what we have now
- @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)
- we'd also need a way to preview it somehow
from nushell.github.io.
There are two things I most care about:
- 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.
- 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.
we're always interested in making things better but it's not clear how that is true with starlight.
from nushell.github.io.
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.
And does it support styling/highlighting nushell language syntax?
from nushell.github.io.
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.
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.
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.
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)
- Generate terminal output HOT 1
- Step value of range is not mentioned in document HOT 1
- A page on control flow HOT 1
- Generate documentation for `std` commands
- Update modules page to disallow empty mod.nu HOT 1
- Issue with terminology in Thinking in Nu page HOT 3
- Add documentation for multi-dot paths HOT 2
- Remove `$nothing` from document HOT 1
- Replace std testing with nupm HOT 5
- Explanations in the cheat sheet should come before the code that's explained HOT 2
- The Cookbook Setup page references the now-removed `env` command several times HOT 2
- Broken links HOT 4
- Quick Tour example not related to the text
- Something error syntax in zh-CN/README.md HOT 3
- [Overlays] Basic example is not usable with latest Nushell HOT 4
- Dataframe page polars dtypes command fails HOT 2
- `format date` is not listed in Strings category commands HOT 1
- Query help page should mention it's a plugin HOT 3
- Add Comparison with PowerShell / NGS HOT 6
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 nushell.github.io.