diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..04fd6799d9b2ce2cc6794081761641d17bb20292 --- /dev/null +++ b/README.en.md @@ -0,0 +1,60 @@ + + +# Struct Docs + +This is a documentation site template based on Remixicon, suitable for displaying structured documentation content. + +## Features + +- Responsive layout design +- Supports document navigation and search functionality +- Provides a feedback collection module +- Multilingual support (including Chinese and English) + +## File Structure + +- `assets/`: Stores static resource files such as fonts, images, and style sheets. +- `snippets/`: Contains reusable HTML snippets. +- `src/`: Source code directory containing JavaScript and style sheet files. +- `templates/`: Page template files. +- `locales/`: Multilingual support files. +- `config/`: Configuration file directory. + +## Technologies Used + +- HTML5 +- CSS3 (includes the DaisyUI framework) +- JavaScript (ES6+) +- Liquid template engine + +## Installation and Usage + +1. Clone the repository: + ```bash + git clone https://gitee.com/cheng-t1/struct_docs.git + ``` + +2. Install dependencies: + ```bash + cd struct_docs + yarn install + ``` + +3. Start the development server: + ```bash + yarn start + ``` + +## Contributing + +We welcome code contributions and documentation improvements. Please follow these steps: + +1. Fork the repository +2. Create a new branch (`git checkout -b feature/new-feature`) +3. Commit your changes (`git commit -am 'Add new feature'`) +4. Push your branch (`git push origin feature/new-feature`) +5. Create a Pull Request + +## License + +This project is licensed under the MIT License. See the LICENSE file for details. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..996a4bbb98cb83a352c4fc44556fe9ad92bb6d53 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# Struct Docs + +这是一个基于 Remixicon 的文档站点模板,适用于展示结构化文档内容。 + +## 功能特性 + +- 响应式布局设计 +- 支持文档导航与搜索功能 +- 提供反馈收集模块 +- 支持多语言(含中文与英文) + +## 文件结构 + +- `assets/`:存放静态资源文件,如字体、图片与样式表。 +- `snippets/`:包含可复用的 HTML 片段。 +- `src/`:源代码目录,包含 JavaScript 与样式表文件。 +- `templates/`:页面模板文件。 +- `locales/`:多语言支持文件。 +- `config/`:配置文件目录。 + +## 使用技术 + +- HTML5 +- CSS3 (包含 DaisyUI 框架) +- JavaScript (ES6+) +- Liquid 模板引擎 + +## 安装与运行 + +1. 克隆仓库: + ```bash + git clone https://gitee.com/cheng-t1/struct_docs.git + ``` + +2. 安装依赖: + ```bash + cd struct_docs + yarn install + ``` + +3. 启动开发服务器: + ```bash + yarn start + ``` + +## 贡献指南 + +欢迎贡献代码与改进文档。请遵循以下步骤: + +1. Fork 仓库 +2. 创建新分支 (`git checkout -b feature/new-feature`) +3. 提交更改 (`git commit -am 'Add new feature'`) +4. 推送分支 (`git push origin feature/new-feature`) +5. 创建 Pull Request + +## 许可证 + +本项目采用 MIT 许可证。详情请查看 LICENSE 文件。 \ No newline at end of file