amoschou/grapho

从Markdown文件夹创建Laravel应用程序作为书籍。

dev-main 2023-12-07 22:35 UTC

This package is auto-updated.

Last update: 2024-09-08 00:34:48 UTC


README

从Markdown文件夹创建Laravel应用程序作为书籍。

安装

使用以下方式安装包

composer require amoschou/grapho

然后,如果需要,发布供应商文件

php artisan vendor:publish --tag=grapho-config
php artisan vendor:publish --tag=grapho-views

配置

resources/src/grapho(或您配置的路径)中创建一个新文件夹,并将Markdown文件放在此处。

每个页面的URL中插入路由前缀。

GitHub仓库是Markdown文件的来源。此信息用于“编辑此页”按钮。

浏览到 example.com/docs 以查看渲染的Markdown文件。

Markdown文件夹的结构

默认情况下,Markdown文件夹位于 resources/src/grapho。将所有Markdown文件放在文件夹中,形成一个树状结构。所有markdown文件必须具有 .md 后缀。不允许文件夹上有 .md 后缀。

Markdown文件可以包含YAML前端信息,包含两个键值对 titleord

---
title: The title of the page
ord: 3
---

# Continue writing markdown in this file.

标题用于目录和面包屑导航。ord是一个用于排序文件和文件夹的数字。如果没有此信息,则默认标题取自文件名(不带 .md 后缀),默认ord为 0。如果多个文件夹或文件具有相同的ord,则它们将无特定顺序列出(可能是按字母顺序)。

文件夹也可以通过文件夹内的 _index.yaml 文件定义标题和顺序。