Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update sidebar #2891

Merged
merged 4 commits into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 77 additions & 50 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,94 +20,121 @@ export default defineConfig({
{ text: "Tasks", link: "/tasks/" },
],
sidebar: [
{ text: "Getting Started", link: "/getting-started" },
{ text: "Walkthrough", link: "/walkthrough" },
{ text: "About", link: "/about" },
{ text: "Continuous Integration", link: "/continuous-integration" },
{ text: "Demo", link: "/demo" },
{ text: "FAQs", link: "/faq" },
{ text: "Troubleshooting", link: "/troubleshooting" },
{ text: "How I Use mise", link: "/how-i-use-mise" },
{ text: "IDE Integration", link: "/ide-integration" },
{ text: "Paranoid", link: "/paranoid" },
{ text: "Registry", link: "/registry" },
{ text: "Plugins", link: "/plugins" },
{ text: "Coming from rtx", link: "/rtx" },
{ text: "Team", link: "/team" },
{ text: "Contributing", link: "/contributing" },
{ text: "Tips & Tricks", link: "/tips-and-tricks" },
{
text: "Guides",
items: [
{ text: "Getting Started", link: "/getting-started" },
{
text: "Walkthrough",
link: "/walkthrough",
collapsed: true,
items: [{ text: "Demo", link: "/demo" }],
},
{ text: "IDE Integration", link: "/ide-integration" },
{ text: "Continuous Integration", link: "/continuous-integration" },
],
},
{
text: "Configuration",
link: "/configuration",
items: [{ text: "Settings", link: "/configuration/settings" }],
items: [
{ text: "mise.toml", link: "/configuration" },
{ text: "Settings", link: "/configuration/settings" },
],
},
{
text: "Dev Tools",
link: "/dev-tools/",
items: [
{ text: "Aliases", link: "/dev-tools/aliases" },
{ text: "Dev tools overview", link: "/dev-tools/" },
{ text: "Comparison to asdf", link: "/dev-tools/comparison-to-asdf" },
{ text: "Shims", link: "/dev-tools/shims" },
{ text: "Aliases", link: "/dev-tools/aliases" },
{
text: "Backends",
link: "/dev-tools/backends/",
text: "Plugins / Languages",
link: "/plugins",
items: [
{ text: "asdf", link: "/dev-tools/backends/asdf" },
{ text: "cargo", link: "/dev-tools/backends/cargo" },
{ text: "go", link: "/dev-tools/backends/go" },
{ text: "npm", link: "/dev-tools/backends/npm" },
{ text: "pipx", link: "/dev-tools/backends/pipx" },
{ text: "spm", link: "/dev-tools/backends/spm" },
{ text: "ubi", link: "/dev-tools/backends/ubi" },
{ text: "vfox", link: "/dev-tools/backends/vfox" },
{
text: "Core tools",
link: "/core-tools",
collapsed: true,
items: [
{ text: "Bun", link: "/lang/bun" },
{ text: "Deno", link: "/lang/deno" },
{ text: "Erlang", link: "/lang/erlang" },
{ text: "Go", link: "/lang/go" },
{ text: "Java", link: "/lang/java" },
{ text: "Node.js", link: "/lang/node" },
{ text: "Python", link: "/lang/python" },
{ text: "Ruby", link: "/lang/ruby" },
{ text: "Rust", link: "/lang/rust" },
],
},
{ text: "Tool registry", link: "/registry" },
{
text: "Tool backends",
link: "/dev-tools/backends/",
collapsed: true,
items: [
{ text: "asdf", link: "/dev-tools/backends/asdf" },
{ text: "cargo", link: "/dev-tools/backends/cargo" },
{ text: "go", link: "/dev-tools/backends/go" },
{ text: "npm", link: "/dev-tools/backends/npm" },
{ text: "pipx", link: "/dev-tools/backends/pipx" },
{ text: "spm", link: "/dev-tools/backends/spm" },
{ text: "ubi", link: "/dev-tools/backends/ubi" },
{ text: "vfox", link: "/dev-tools/backends/vfox" },
],
},
],
},
],
},
{
text: "Environments",
link: "/environments",
items: [
{ text: "direnv", link: "/direnv" },
{ text: "Environment variables", link: "/environments/" },
{ text: "Profiles", link: "/profiles" },
{ text: "Templates", link: "/templates" },
{ text: "direnv", link: "/direnv" },
],
},
{
text: "Tasks",
link: "/tasks/",
items: [
{ text: "Task overview", link: "/tasks/" },
{ text: "Running Tasks", link: "/tasks/running-tasks" },
{ text: "File Tasks", link: "/tasks/file-tasks" },
{ text: "TOML Tasks", link: "/tasks/toml-tasks" },
{ text: "File Tasks", link: "/tasks/file-tasks" },
],
},
{ text: "FAQs", link: "/faq" },
{ text: "Troubleshooting", link: "/troubleshooting" },
{ text: "Tips & Tricks", link: "/tips-and-tricks" },
{
text: "Languages",
text: "About",
items: [
{ text: "Bun", link: "/lang/bun" },
{ text: "Deno", link: "/lang/deno" },
{ text: "Erlang", link: "/lang/erlang" },
{ text: "Go", link: "/lang/go" },
{ text: "Java", link: "/lang/java" },
{ text: "Node.js", link: "/lang/node" },
{ text: "Python", link: "/lang/python" },
{ text: "Ruby", link: "/lang/ruby" },
{ text: "Rust", link: "/lang/rust" },
{ text: "About mise", link: "/about" },
{ text: "Team", link: "/team" },
{ text: "Project Roadmap", link: "/project-roadmap" },
{ text: "Contributing", link: "/contributing" },
],
},
{
text: "Internals",
text: "Advanced",
items: [
{ text: "Cache Behavior", link: "/cache-behavior" },
{ text: "Paranoid", link: "/paranoid" },
{ text: "Templates", link: "/templates" },
{ text: "Coming from rtx", link: "/rtx" },
{ text: "How I Use mise", link: "/how-i-use-mise" },
{ text: "Directory Structure", link: "/directories" },
{ text: "Project Roadmap", link: "/project-roadmap" },
{ text: "Cache Behavior", link: "/cache-behavior" },
],
},
{
text: "CLI Reference",
link: "/cli/",
items: cliReference(commands),
collapsed: true,
items: [
{ text: "CLI overview", link: "/cli/" },
...cliReference(commands),
],
},
],

Expand Down
17 changes: 17 additions & 0 deletions docs/core-tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Core Tools

`mise` comes with some plugins built into the CLI written in Rust. These are new and will improve over
time.

They can be easily overridden by installing a plugin with the same name, e.g.: `mise plugin install python https://github.com/asdf-community/asdf-python`.

You can see the core plugins with `mise plugin ls --core`.

- [Bun](/lang/bun)
- [Deno](/lang/deno)
- [Erlang](/lang/erlang) <Badge type="warning" text="experimental" />
- [Go](/lang/go)
- [Java](/lang/java)
- [NodeJS](/lang/node)
- [Python](/lang/python)
- [Ruby](/lang/ruby)
Loading