Rin 5 技术文档

2024-12-28 04:25:57作者：伍希望

1. 安装指南

在开始使用 Rin 5 之前，确保您的系统已经安装了 Node.js。可以从 Node.js 官网下载并安装。

安装完成后，按照以下步骤克隆 Rin 5 仓库并设置项目：

$ git clone git@github.com:sanographix/rin.git test-repo
$ cd test-repo
$ npm install

2. 项目的使用说明

Rin 5 会监视 src/ 目录下的文件。将您的项目模板（EJS）、SCSS、JS 和图片文件放在这个目录下。templates/、scss/、js/ 和 images/ 文件会编译并输出到 build/ 目录。

项目目录结构如下：

rin/
┣┳ src/
┃┣ templates/
┃┣ scss/
┃┣ js/
┃┗ images/
┃
┗┳ build/
 ┗┳ index.html
  ┣ css/
  ┣ js/
  ┗ images/

模板

Rin 支持 EJS 模板。当您编辑并保存 src/templates/pages 目录下的 .ejs 文件时，它们会输出为 .html 文件到 build/ 目录。

模板标签

site.json

在每页中使用的变量可以放在 site.json 文件中。

示例：

{
  "siteName": "示例站点",
  "siteRootUrl": "http://example.com/",
  "ogImageUrl": "http://example.com/images/og-image.jpg",
  "fbAppId": "000000000",
  "twitterSite": "@sanographix",
  "googleAnalyticsId": "UA-00000000-1"
}

index.ejs

在特定页面中使用的变量可以放在 <% var %> 标签中。

示例：

<% var
pageTitle = "首页";
pageDescription = "示例站点";
%>
<head>
  <title><%= pageTitle %> - <%= siteName %></title>
  <meta property="og:description" content="<%= pageDescription %>" />
</head>

编译后的结果：

<head>
  <title>首页 - 示例站点</title>
  <meta property="og:description" content="示例站点" />
</head>

3. 项目API使用文档

Rin 5 的 API 使用文档暂不提供，因为该项目主要是作为一个前端模板框架，而不是提供API调用的库。

4. 项目安装方式

除了通过 git clone 的方式外，您还可以通过以下命令安装 Rin 5：

$ npm install -g rin

然后，在您的项目中运行以下命令来初始化 Rin 5：

$ rin init

以上是关于 Rin 5 的技术文档。希望对您有所帮助。

登录后查看全文

项目优选

收起

🎉 (RuoYi)官方仓库基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统

🔥🔥🔥ShopXO企业级免费开源商城系统，可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存，遵循MIT开源协议发布、基于ThinkPHP8框架研发

JavaScript

openGauss-server

openGauss kernel ~ openGauss is an open source relational database management system

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件，通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求，让密码技术应用更简单，同时探索后量子等先进算法创新实践，构建密码前沿技术底座！

🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端

TypeScript

596

CangjieCommunity

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境

Markdown

1.07 K

HarmonyOS-Examples

本仓将收集和展示仓颉鸿蒙应用示例代码，欢迎大家投稿，在仓颉鸿蒙社区展现你的妙趣设计！

本仓将收集和展示高质量的仓颉示例代码，欢迎大家投稿，让全世界看到您的妙趣设计，也让更多人通过您的编码理解和喜爱仓颉语言。

Cangjie

332

1.08 K

Rin 5 技术文档

1. 安装指南

2. 项目的使用说明

模板

模板标签

site.json

index.ejs

3. 项目API使用文档

4. 项目安装方式

热门内容推荐

最新内容推荐

项目优选

Rin 5 技术文档

1. 安装指南

2. 项目的使用说明

模板

模板标签

site.json

index.ejs

3. 项目API使用文档

4. 项目安装方式

相关内容推荐

热门内容推荐

最新内容推荐

项目优选