artisan-build/docsidian

适用于Obsidian的Markdown文档站点生成器

dev-main 2024-07-29 19:51 UTC

This package is auto-updated.

Last update: 2024-08-29 20:02:25 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Docsidian是一个基于Laravel的、针对我们如何使用Obsidian进行优化的文档站点生成器。它允许我们在Obsidian保险库的任何文件夹中简单地创建一个git仓库来创建项目文档,或者在任何项目文档文件夹中挂载一个文件夹作为Obsidian保险库并构建。

尚未准备就绪供您使用

这还处于非常早期的开发阶段。我们已经在一些项目上进行了狗食测试,但它在短时间内将会快速变化并可能崩溃。准备好时我们将进行公告。

Docsidian是Scalpels的一部分

安装

您可以通过composer安装此包

composer require artisan-build/docsidian

您可以使用以下命令发布和运行迁移

php artisan vendor:publish --tag="docsidian-migrations"
php artisan migrate

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="docsidian-config"

这是发布配置文件的内容

return [
];

可选地,您可以使用以下命令发布视图

php artisan vendor:publish --tag="docsidian-views"

用法

$docsidian = new ArtisanBuild\Docsidian();
echo $docsidian->echoPhrase('Hello, ArtisanBuild!');

测试

composer test

变更日志

请参阅变更日志以获取有关最近更改的更多信息。

贡献

请参阅贡献指南以获取详细信息。

安全漏洞

请审查我们的安全策略以了解如何报告安全漏洞。

鸣谢

许可

MIT许可(MIT)。有关更多信息,请参阅许可文件