Markdown-Rails 项目使用教程

41 0 0

Markdown-Rails 项目使用教程

markdown-railsMarkdown as a static templating language for Rails views and partials项目地址:https://gitcode.com/gh_mirrors/ma/markdown-rails

1. 项目的目录结构及介绍

Markdown-Rails 项目的目录结构如下：

markdown-rails/ ├── app/ │ ├── controllers/ │ ├── helpers/ │ ├── models/ │ ├── views/ │ │ └── pages/ │ │ └── blog/ │ │ └── new_post.html.md ├── bin/ ├── config/ │ ├── initializers/ │ │ └── markdown.rb │ ├── routes.rb ├── db/ ├── lib/ ├── public/ ├── test/ ├── vendor/ ├── Gemfile ├── Gemfile.lock └── README.md

目录结构介绍

app/: 包含应用程序的主要代码，包括控制器、模型、视图等。
- controllers/: 控制器文件。
- helpers/: 辅助方法文件。
- models/: 模型文件。
- views/: 视图文件，其中 pages/blog/new_post.html.md 是一个 Markdown 文件示例。
bin/: 包含可执行文件。
config/: 配置文件目录。
- initializers/: 初始化文件，如 markdown.rb 用于配置 Markdown 处理。
- routes.rb: 路由配置文件。
db/: 数据库相关文件。
lib/: 自定义库文件。
public/: 公共文件，如静态文件。
test/: 测试文件。
vendor/: 第三方库文件。
Gemfile: 依赖管理文件。
Gemfile.lock: 依赖锁定文件。
README.md: 项目说明文件。

2. 项目的启动文件介绍

项目的启动文件主要是 bin/dev 和 config/routes.rb。

`bin/dev`

bin/dev 是一个用于启动开发环境的脚本，通常用于启动多个进程，如 Web 服务器和 CSS 处理进程。

`config/routes.rb`

config/routes.rb 是 Rails 项目的路由配置文件，定义了 URL 和控制器动作之间的映射关系。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/initializers/ 目录下。

`config/initializers/markdown.rb`

markdown.rb 文件用于配置 Markdown 处理，包括注册 Markdown 处理器和定义 Markdown 渲染方法。


# config/initializers/markdown.rb
# 定义一个模块，用于将 Markdown 解析为 HTML
module MarkdownHandler
  def self.erb
    @erb ||= ActionView::Template.registered_template_handler(:erb)
  end
 
  def self.call(template)
    compiled_source = erb.call(template)
    "Redcarpet::Markdown.new(Redcarpet::Render::HTML.new).render(begin;#{compiled_source};end).html_safe"
  end
end
 
# 告诉 Rails 使用 MarkdownHandler 处理 .md 文件
ActionView::Template.register_template_handler :md, MarkdownHandler