Docs
Kongying Tavern Genshin Interactive Map Docs
## Overview
The空荧地图文档 is an intriguing project that leverages modern web development technologies to deliver content in a user-friendly manner. Built with VitePress and written in Markdown, this project aims to provide seamless editing capabilities and robust functionality, perfect for contributors looking to engage with the content. The emphasis on using Node.js v18.0.0 or higher highlights the focus on utilizing the latest JavaScript features, which ensures a smooth performance and modern coding practices.
The project is still labeled as a work in progress, indicating that there are ongoing developments and contributions. This aspect provides a unique opportunity for tech enthusiasts and developers alike to participate and enhance the project, fostering a collaborative environment that continually evolves and improves.
## Features
- **Markdown Content**: The site content is structured in Markdown format, making it easy to read and edit for contributors of all skill levels.
- **VitePress Framework**: Utilizes VitePress for quick and efficient site generation, ensuring fast load times and a smooth user experience.
- **Node.js Requirement**: Supports modern JavaScript features, requiring Node.js v18.0.0 or higher, which enhances performance and coding efficiency.
- **Local Development**: Offers local development options using pnpm as the preferred package manager, streamlining the setup process for developers.
- **Open Contribution**: Encourages community contributions through GitHub, allowing users to suggest edits and improvements via Pull Requests.
- **Support for Vue Syntax**: Includes the capability to use Vue syntax within Markdown, providing developers with powerful tools for dynamic content creation.
- **License**: Operates under the MIT License, promoting open-source principles and providing freedom for users to use, modify, and distribute the software.
- Vite
Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects
- Vitepress
VitePress is a static site generator designed for creating documentation websites. It offers a lightweight and fast development experience using Vue.js and Markdown, with features such as live-reload, theming, and customizable layout components.
- Vue
Vue.js is a lightweight and flexible JavaScript framework that allows developers to easily build dynamic and reactive user interfaces. Its intuitive syntax, modular architecture, and focus on performance make it a popular choice for modern web development.
- SCSS
SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.
- UnoCSS
UnoCSS is an instant, on-demand atomic CSS engine that generates utility classes at build time. It's highly customizable, extremely fast, and compatible with Tailwind CSS utilities while offering additional features like attributify mode and pure CSS icons.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Stylelint
Stylelint is a modern linter for CSS that helps you avoid errors and enforce consistent styling conventions. It provides rules for detecting errors and warnings, and can be configured to match your specific project's requirements.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
- Pinia
Pinia is the official state management library for Vue.js. It provides a simple and intuitive API with full TypeScript support, devtools integration, and modular design. Pinia replaces Vuex as the recommended state management solution for Vue 3.
- Zod
Zod is a TypeScript-first schema declaration and validation library. It allows you to define schemas that can validate data at runtime while providing excellent TypeScript inference, making it perfect for API validation, form validation, and type-safe data handling.