使用sami生成文档
2024-09-02 22:00:28
从composer安装sami
$ composer require sami/sami
composer自动配置完以后,可以先测试一下是否安装成功。只要不带参数的运行一下sami,就会知道结果。
$ php vendor/sami/sami/sami.php
如果不出意外,安装是成功的。那么要使用sami,就需要自己先写一个config.php文件,内容如下:
use Sami\Sami;
//Finder 是一个symfony的文件查找组件,用该组件去匹配文件和目录非常的方便
use Symfony\Component\Finder\Finder; $dir = __DIR__; $iterator = Finder::create()
->files()
->name('*.php')//设置查找的文件类型
->exclude('document')//排除不做查找的路径,这里的document是生成的文档所保存的路径
->exclude('vendor')//排除composer组件的路径
->in($dir)
;
return new Sami($iterator,[
'theme' => 'default',//sami安装后默认的有一套文档页面风格模板,名称是default。位置在:vendor/sami/sami/Sami/Resources/themes/下。
'title' => 'Mysic',//项目名称
'build_dir' => __DIR__.'/document/',//设置文档生成后的保存路径
'cache_dir' => __DIR__.'/document/cache/',//设置文档生成时的缓存路径
'default_opened_level' => 2
]);
config文件设置好之后,用sami update一下这个config文件
$ php vendor/sami/sami/sami.php update config.php
不出意外的话,文档应该就会生成了,默认的首页名为index.html,只要在浏览器中打开这个文件,就能看到文档了。
最新文章
- java中Action层、Service层和Dao层的功能区分
- java.io.IOException: mark/reset not supported
- centos 配置 ssl服务
- SSH与Webservice整合记录
- 工作当中实际运用(2)——js原生实现全选/反选
- IOS 基础-define、const、extern、全局变量
- 在asp.net mvc中上传大文件
- sdutoj 2624 Contest Print Server
- 常用JavaBean:JdbcBean codes:Java通过JDBC 连接 Mysql 数据库
- hibernate懒加载(转载)
- Winform之SpreadSheetGear转DevExpress.XtraSpreadsheet.v13.2 z
- SQLite入门与分析(二)---设计与概念
- PHP中的魔术方法总结 :__construct, __destruct , __call, __callStatic,__get, __set, __isset, __unset , __sleep, __wakeup, __toStr
- linux挂载新硬盘
- C++虚函数继承的bug
- 【BZOJ4538】【HNOI2016】网络(树链剖分,线段树,堆)
- Java笔试
- webstorm更改scss输出路径
- Java File mkdir() mkdirs()
- php 会话控制(关于cookie的维护与生命周期)