首页
/ Rin 5 技术文档

Rin 5 技术文档

2024-12-28 11:01:18作者:伍希望

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 的技术文档。希望对您有所帮助。

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
50
13
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
267
383
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
409
311
carboncarbon
轻量级、语义化、对开发者友好的 golang 时间处理库
Go
7
2
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TSX
287
26
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
38
102
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
607
69
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
85
234
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
108
73
凹语言凹语言
凹语言(凹读音“Wā”)是针对 WebAssembly 设计的编程语言,目标:为高性能网页应用提供一门简洁、可靠、易用、强类型的编译型通用语言。凹语言的代码生成器及运行时为全自主研发(不依赖于LLVM等外部项目),实现了全链路自主可控。目前凹语言处于工程试用阶段。
Go
13
4