README

#知识库包

基于LIN3S知识库构建的Symfony包。

##安装确保您的计算机已安装composer。

通过以下composer命令安装组件

$ composer require lin3s/knowledge-base-bundle

为您的知识库安装一个主题。我们在LIN3S使用以下主题

$ composer require lin3s/knowledge-base-gfm-template

将Markdown格式的文档添加到您稍后将添加到配置的文件夹中。默认情况下，此包将从您的项目根路径中的docs文件夹中读取文档。

将包添加到AppKernel.php

$bundles = [
    (...)
    new LIN3S\KnowledgeBaseBundle\LIN3SKnowledgeBaseBundle()
];

在您的app/config/routing.yml文件中导入所需的路由

lin3s_knowledge_base:
    resource: "@LIN3SKnowledgeBaseBundle/Resources/config/routing.yml"

##配置参考在您的config.yml中可以添加以下选项

lin3_s_knowledge_base:
    #### Required ####
    template: LIN3S\KnowledgeBaseGFMTemplate\Template       # Fully qualified namespace of the class extending TemplateInterface

    #### Optional (Default values shown) ####
    docs_path: %kernel.root_dir%/../docs/                   # Path where the docs are located
    build_path: %kernel.cache_dir%/lin3s_knowledge_base/    # Path to the cache
    assets_base_url: /templates                             # Url from where the template will fetch the assets

##生成文档确保您已正确添加文档文件夹并在config.yml中配置了docs_path

$ php app/console lin3s:kb:docs:load

##链接资源以下命令将模板所需的资源转储到web文件夹

$ php app/console lin3s:kb:assets:install

##内部工作原理如需进一步的技术和主题详细信息，请查看LIN3S知识库文档。

##许可选项

lin3s / knowledge-base-bundle

维护者

详细信息

README