在Markdown中轻松管理静态内容：Spatie Sheets

在Markdown中轻松管理静态内容：Spatie Sheets

sheetsStore & retrieve your static content in plain text files项目地址:https://gitcode.com/gh_mirrors/she/sheets

1、项目介绍

Spatie Sheets 是一个基于Laravel的开源包，它允许您以纯文本文件的形式存储和检索静态内容。默认支持Markdown与前导数据（front matter），并且可以扩展以解析任何文档格式。这个工具特别适合构建文档站点和个人博客。

---
title: 主页
---
# 欢迎，世界！

欢迎来到Spatie Sheets！

// 控制器示例
class SheetController
{
    public function index(Sheets $sheets)
    {
        return view('sheet', [
            'sheet' => $sheets->get('home'),
        ]);
    }

    public function show(string $id, Sheets $sheets)
    {
        return view('sheet', [
            'sheet' => $sheets->get($id),
        ]);
    }
}

// 视图示例
@extends('layouts.app', [
    'title' => $sheet->title,
])

@section('main')
    {{ $sheet->contents }}
@endsection

2、项目技术分析

Spatie Sheets 使用 Laravel 的文件系统组件来存放你的内容，并且支持多个不同的内容集合。默认情况下，它处理Markdown文件，并从中提取元数据，但您可以自定义解析和提取功能以适应所需格式。

• 支持任意文档格式
• 内容存储位置可配置
• 多个内容集合管理
• 提供Eloquent-like对象以访问内容属性
• 配置简单，遵循约定优于配置的原则

3、应用场景

• 文档网站：使用Markdown编写易于维护的文档页面。
• 个人博客：将每篇博客文章保存为单独的Markdown文件，方便管理和检索。
• 简单CMS：创建一个简单的内容管理系统，让用户通过Markdown文件进行内容更新。
• 单页应用的数据源：作为SPA应用静默后台提供JSON数据。

4、项目特点

• 灵活的格式支持：默认支持Markdown+front matter，但可扩展用于处理其他文件格式。
• 多集合存储：可创建多个独立的内容集合，如“博客”和“页面”。
• Eloquent风格的对象：返回的Sheet对象类似于Eloquent模型，提供了属性访问和自定义行为。
• 配置友好：零配置启动，或者根据需要调整设置。
• 自动发现与注册：在安装后自动整合到您的Laravel应用。

安装与使用

要开始使用Spatie Sheets，只需运行以下命令：

composer require spatie/sheets

然后发布配置文件并按需配置集合：

php artisan vendor:publish --provider="Spatie\Sheets\SheetsServiceProvider" --tag="config"

最后，按照提供的指南创建你的第一个集合，开始存储和获取内容。

Spatie Sheets是一个强大且灵活的工具，适用于各种场景。其简洁的设计和易于集成的特点使其成为希望简化内容管理的Laravel开发者们的理想选择。如果你正在寻找一个轻量级的解决方案来管理你的Markdown内容，Spatie Sheets绝对值得尝试。

sheetsStore & retrieve your static content in plain text files项目地址:https://gitcode.com/gh_mirrors/she/sheets