This repository contains the source code for nvim-mini.org, the official website for MINI (Modular Independent Neovim Improvements).
The website is built using Quarto and serves as a central hub for:
- mini.nvim: A collection of independent Neovim modules.
- MiniMax: Minimal and Maximally useful Neovim configurations.
- Blog: Announcements and updates about the MINI ecosystem.
index.qmd: The landing page.mini.nvim/: Mirrored documentation and resources from themini.nvimrepository.MiniMax/: Mirrored documentation and resources from theMiniMaxrepository.blog/: Quarto blog posts._scripts/: Lua and shell scripts for syncing and processing documentation.assets/: Images and other static assets.theme/: Quarto themes and syntax definitions.
The content in mini.nvim/ and MiniMax/ is automatically synced from their respective repositories using scripts in _scripts/.
To fetch and sync the latest documentation from the upstream repositories:
# Fetch and sync both mini.nvim and MiniMax
make syncIndividual components can also be synced:
# Sync only mini.nvim
make mini.nvim
# Sync only MiniMax
make MiniMaxThe website is built using Quarto. To preview or render the site locally, you'll need to have Quarto installed.
# Preview the website locally
quarto preview
# Render the website (output to docs/ directory)
quarto renderContributions to the website are welcome! If you find any issues with the documentation or have suggestions for improvements, please open an issue or submit a pull request.
Note that documentation for mini.nvim and MiniMax should be contributed directly to their respective repositories.
The content of this repository is licensed under the MIT License.