https://github.com/mukappalambda/my-nvim-config-docs
https://github.com/mukappalambda/my-nvim-config-docs
documentation lazyvim neovim neovim-config neovim-plugin
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mukappalambda/my-nvim-config-docs
- Owner: mukappalambda
- License: mit
- Created: 2024-07-05T05:26:19.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-28T09:15:07.000Z (9 months ago)
- Last Synced: 2025-09-28T10:21:46.778Z (9 months ago)
- Topics: documentation, lazyvim, neovim, neovim-config, neovim-plugin
- Homepage: https://mukappalambda.github.io/my-nvim-config-docs/
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# My Neovim Config Docs
Welcome to **My Neovim Config Docs**! This repository provides comprehensive documentation for my personalized Neovim configuration. The documentation is generated using [mdBook](https://rust-lang.github.io/mdBook/), making it easy to navigate and maintain.
## 📚 **Overview**
This project aims to document my Neovim configuration, plugins, and customization choices in a clear and organized manner. It serves as a reference for myself and others interested in setting up an efficient Neovim environment.
## 🚀 **Getting Started**
Follow these steps to set up the documentation locally on your machine.
### **Prerequisites**
To build and view the documentation, you need to have the following installed:
- [Rust](https://www.rust-lang.org/tools/install) (required to install mdBook)
- mdBook: Install it via cargo using the command:
```bash
cargo install mdbook
```
### **Clone the Repository**
```bash
git clone https://github.com/mukappalambda/my-nvim-config-docs.git
cd my-nvim-config-docs
```
### **Build the Documentation**
```bash
mdbook build
```
This will generate the static HTML files in the `book/` directory.
### **Serve the Documentation Locally**
```bash
mdbook serve
```
Visit `http://localhost:3000` in your browser to view the documentation with live reload support.
## 📂 **Project Structure**
Here’s a breakdown of the folder structure:
- WIP
### **Key Files**
- **book.toml**: Configuration file for mdBook.
- **src/SUMMARY.md**: Contains the table of contents for the documentation.
- **src/**: This directory contains all the markdown files that make up the documentation.
## ✍️ **How to Contribute**
- WIP
## 📘 **Documentation Sections**
- WIP
## 🛠️ **Useful Commands**
| Command | Description |
| -------------- | ------------------------------- |
| `mdbook build` | Build the static documentation |
| `mdbook serve` | Serve the documentation locally |
## 📦 **Dependencies**
- [Rust](https://www.rust-lang.org/): Required to install mdBook.
- [mdBook](https://rust-lang.github.io/mdBook/): For generating the documentation.
## 📜 **License**
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
---
Feel free to explore, contribute, and learn from this documentation! If you encounter any issues or have questions, don't hesitate to open an issue or submit a pull request.