Rin 5 技术文档

2024-12-28 20:26: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 的技术文档。希望对您有所帮助。

登录后查看全文

项目优选

收起

kernel

deepin linux kernel

docs

OpenHarmony documentation | OpenHarmony开发者文档

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台，包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分，采用java语言实现，可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用

Java

pytorch

Ascend Extension for PyTorch

Python

RuoYi-Vue3

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

本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。

C++

547

openGauss-server

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

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

1.02 K

399

community

本项目是CANN开源社区的核心管理仓库，包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息

392