当前位置: 首页 > 工具软件 > Raneto > 使用案例 >

Raneto使用

顾嘉德
2023-12-01

Raneto使用

身份验证

在 config.js中将 authentication改为true
在credentials 修改 username 和 password.
重新启动服务器

配置Raneto

在根目录地下编辑config.js
其中包含一些变量配置如下:

// Your site title (format: page_title - site_title)
site_title: 'Example Site',
// The base URL of your site (can use  in Markdown files)
base_url: '',
// Used for the "Get in touch" page footer link
support_email: 'support@example.com',
// Footer copyright content
copyright: 'Copyright © Example Site',
// Excerpt length (used in search)
excerpt_length: 400
// ...

这些变量可以随意配置,重新配置后需重新启动应用。
可以在里面添加自定义的模板。

创建Pages

用自己喜欢的Markdown编辑器,编辑 Markdown文件(.md)

  1. 文件位置

    所有你的.md文件都必须包含在Raneto的根目录下的/example/content的目录下,可以添加子文件夹到该目录下。
    可以使用子文件夹的创建的“类别”页面。
    例如,如果创建一个名为using-my-product所有页面的子文件夹在文件夹下将出现在Raneto使用我的产品类别。可以创建尽可能多的级别的子文件夹来你喜欢但是他们总是表现为一个顶级类别。
    子文件夹也将被添加到页面的URL或“slug”

  2. 文件命名

    文件的名称定义了URL或“slug”是用于导航到页面。
    例如,如果创建一个文件叫做my-example-page.md 将访问这个页面是example.com/my-example-page导航。

3.文件的标记

在页面的顶部可以一块注释指定页面的某些属性。
例如指定页面的标题或描述使用搜索引擎。
/*
标题: My Page Title
描述: Optional description for search engines
*/

客户端首页

默认Raneto显示一个知识库首页列出所有文章(和类别)和固定知识库的设计。
然而如果想覆盖这个页面和一个定制的主页,可以创建一个index.md文件在content目录下。

自定义模板

所有的模板视图可以在 themes/default/ 文件夹下找到

  • layout.html:父模板
  • home.html: 主页模板。如果没有一个index.md显示
  • page.html: 单页模板
  • search.html: 用于搜索的模板
  • error.html:显示当Raneto遇到一个错误或找不到页面了

Raneto中所有静态文件(图片、CSS、Javascript文件等)提供的公共文件夹。这是没有人可以访问任何其他文件在安装。只有在公共文件夹中文件是向公众开放。

 类似资料: