Skip to content

Latest commit

 

History

History
221 lines (181 loc) · 6.4 KB

configurations.md

File metadata and controls

221 lines (181 loc) · 6.4 KB
Raw

Configurations

With the installation of LaRecipe you will find a new configuration file located at config/larecipe.php. In this file, you can find various options to change the configuration of your LaRecipe installation.

Routing

LaRecipe by default assumes that you want to use it for creating documentations, for that the default route is set to /docs. Moreover, you can set the default path of your markdown docs, by default it assumes /resources/docs.

{warning} LaRecipe will try to locate index.md in each of your documentations versions in order to generate the sidebar index. You can create the files manually or you can generate them using LaRecipe docs generator.

.
├─ config
│  └─ larecipe.php
└─ resources
   └─ docs
      │─ 1.0
      │  │─ index.md
      │  └─ overview.md
      └─ 2.0
         │─ index.md
         └─ overview.md

{info} The landing page is used to redirect your users to it if they visit your docs root route without specifying the page, by default it assumes overview.md.

return [
    'docs'      => [
        'route'   => '/docs',
        'path'    => '/resources/docs',
        'landing' => 'overview'
    ]
];

Versions

Here you may specify the published versions of your documentation that users can view and the default version to be redirected to if your users visit the root route of your docs without specifying the intended page.

{warning} Make sure to list the default version in the published versions list.

return [
    'versions'      => [
        'default'   => '1.0',
        'published' => [
            '1.0'
        ]
    ]
];

Settings

These options configure the additional behaviors of your documentation where you can limit the access to only authenticated users in your system. Moreover, you can setup Google Analytics service by adding your ga_id.

{info} When you set the auth to true, LaRecipe will activate Laravel's web auth middleware on the entire docs.

return [
    'settings' => [
        'auth'  => false,
        'auth_links' => [
            [
                'name' => '',
                'url' => '',
            ],
        ],
        'ga_id' => ''
    ]
];

Cache

Obviously rendering markdown at the back-end is costly especially if the rendered files are massive. Thankfully, caching is considered as a good option to speed up your app when having high traffic. However, this option is not enabled by default.

{primary} Caching period unit: minutes

return [
    'cache'       => [
        'enabled' => false,
        'period'  => 5
    ]
];

Search

Here you can add configure the search functionality of your docs. You can choose the default engine of your search from the list. However, you can also enable/disable the search's visibility. Supported Search Engines: algolia, internal

{warning} Algolia DocSearch requires you to submit your site to them for indexing before it starts working.

For more information, refer to Algolia DocSearch's documentation

return [
    'search'            => [
        'enabled'       => false,
        'default'       => 'algolia',
        'engines'       => [
            'internal'  => [
                'index' => ['h2', 'h3']
            ],
            'algolia'   => [
                'key'   => '',
                'index' => ''
            ]
        ]
    ]
];

Repository

This is an optional configuration you can set in order to show the external link to your documentation's repository if you have one. Once you set the value of the url, LaRecipe automatically will show the nav button.

return [
    'repository'   => [
        'provider' => 'github',
        'url'      => 'https://github.com/saleem-hadad/larecipe'
    ]
];

Appearance

Here you can add configure the appearance of your docs. For example, you can change the default logo, control the visibility of the back-to-top button and many more. However, you can add your own CSS and JS files if you like.

{primary} Currently Supported Themes: light, dark

return [
    'ui'                 => [
        'show_app_name'  => true,
        'logo'           => '', // e.g.: /images/logo.svg
        'fav'            => '', // e.g.: /fav.png
        'theme'          => 'light',
        'code'           => 'dark',
        'back_to_top'    => true,
        'show_side_bar'  => true,
        'colors'         => [
            'primary'    => '#787AF6',
            'secondary'  => '#2b9cf2',
            'selection'  => '#f4f5f7'
        ],
        'additional_css' => [
            //'css/custom.css',
        ],
        'additional_js'  => [
            //'js/custom.js',
        ],
    ]
];

SEO

These options configure the SEO settings of your docs. However, LaRecipe by default sets the canonical link to the viewed page's link automatically.

return [
    'seo'                 => [
        'author'          => '',
        'description'     => '',
        'keywords'        => '',
        'og'              => [
            'title'       => '',
            'type'        => 'article',
            'url'         => '',
            'image'       => '',
            'description' => '',
        ]
    ]
];

Forum

Giving a chance to your users to post thier questions or feedback directly on your docs, is pretty nice way to engage them more. However, you can also disable the forum's visibility if you don't like the idea. Supported Services: disqus

{info} Disqus is a great way to setup forum inside your website/docs in few steps. Create a site and paste its name in the site_name to activate the disqus forum.

return [
    'forum'                 => [
        'enabled'           => false,
        'default'           => 'disqus',
        'services'          => [
            'disqus'        => [
                'site_name' => '', // yoursite.disqus.com
            ]
        ]
    ]
];