Rin 5 技术文档

2024-12-28 16:55:21作者：伍希望

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

登录后查看全文

Rin 5 技术文档

1. 安装指南

2. 项目的使用说明

模板

模板标签

site.json

index.ejs

3. 项目API使用文档

4. 项目安装方式

热门内容推荐

最新内容推荐

项目优选

Rin 5 技术文档

1. 安装指南

2. 项目的使用说明

模板

模板标签

site.json

index.ejs

3. 项目API使用文档

4. 项目安装方式

相关内容推荐

热门内容推荐

最新内容推荐

项目优选