Skip to content

Commit 1467089

Browse files
committed
docs: document theme configuration
Fixes: #50
1 parent ab965d7 commit 1467089

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,22 @@ Files are contained into sections, depending on how Doctum needs to treat them:
336336
.. _MariaDB MySQL Kbs: https://williamdes.github.io/mariadb-mysql-kbs/
337337
.. _Laravel: https://laravel.com/api/master/index.html
338338

339+
Theme configuration
340+
~~~~~~~~~~~~~~~~~~~
341+
342+
.. code-block:: php
343+
344+
<?php
345+
346+
return new Doctum($iterator, [
347+
// [...]
348+
'theme' => 'my-theme-name',
349+
// Add the path to the theme/themes
350+
'template_dirs' => [__DIR__ . '/themes/my-theme-name'],
351+
// [...]
352+
]
353+
);
354+
339355
Search Index
340356
~~~~~~~~~~~~
341357

0 commit comments

Comments
 (0)