Style-Guide-Boilerplate是一款开源可复用的前端框架，可以用来生成在线手册。遵守MIT开源协议。基于PHP编写。

使用指南：

设置项目名称

打开 index.php 文件，查找第 2行，其中显示： $project_name ="Project"; 在引号之间写入项目名称

将自定义的CSS连接到样式指南

在样式指南 Boilerplate <head> are样板是样板本身的自定义样式。 有sg-前缀。

在样板的自定义样式下面，可添加自定义样式表使用。

 <!-- Replace below stylesheet with your own stylesheet -->

<link rel=“stylesheet” href=“css/theme.css”>

 

网站上设置路径

建议在网站目录的root 中创建名为 style-guide的目录。 可以去 anysite.com/style-guide/ 查看网站。

上传文件

需要一个支持PHP的服务器。 只要将来自 GitHub repo的文件上传到新创建的目录，就可以完成。

查看实时站点 CSS

去 yoursite.com/style-guide/，查看站点的CSS如何影响基本元素。 最后一步是创建站点的自定义模式/模块。

创建自定义文档文件

可以创建介绍或者其他文档文件。 只需创建包含内容的html文件，在html中设置样式，并将该文件作为 document-title.html 上传到 style-guide 目录的docs 目录内。

配置基础元素

默认情况下，样板文件带有颜色。字体。 可以编辑这些或者添加新的东西，比如图标或者图片，也可以创建一个html文件并上传到 foundation 目录。

 

创建自定义基本样式模式

可以通过添加。删除或者修改 markup/ 目录中的文件，将文件添加到style-guide 目录的markup/patterns 目录中来定制。

在 yoursite.com/style-guide/ 中看新模式

###Create 使用文档

例如如果要创建 markup/patterns/breadcrumbs.html, 文档，创建名为 breadcrumbs.html的文件并将它的保存。在 yoursite.com/style-guide/ 中即可看到新的文档。

 

[repo owner=”bjankord” name=”Style-Guide-Boilerplate”]