Skip to content

Commit

Permalink
Configuration-table in README
Browse files Browse the repository at this point in the history
  • Loading branch information
OleVik committed Dec 28, 2019
1 parent 1894dd6 commit bb239ee
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,25 @@ A demonstration is available at [OleVik.me/staging/grav-skeleton-scholar](https:

### Configuration

| Option | Default | Description |
|---------------------|---------|-----------------------------------------------|
| enabled | true | Enable theme |
| style | metal | Default Style to load |
| toolbar.breadcrumbs | true | Enable breadcrumbs in toolbar |
| toolbar.search | true | Enable search-field in toolbar |
| toolbar.navigation | true | Enable navigation-drawer in toolbar |
| css | true | Load theme's CSS |
| js | true | Load theme's JS |
| itemize | true | Assign indices to paragraphs |
| linked_data | true | Generated Linked Data |
| components | [List] | List of components to enable |
| router | true | Enable dynamic routes |
| routes | [Dict] | Key-value list of routes |
| api | [Dict] | Hierarchical key-value list of classes to use |
| flexsearch | [Dict] | Options for FlexSearch |
| flexsearch.enabled | true | Enable FlexSearch |
| Option | Default | Description |
|---------------------|-----------|-----------------------------------------------|
| enabled | true | Enable theme |
| style | metal | Default Style to load |
| toolbar.breadcrumbs | true | Enable breadcrumbs in toolbar |
| toolbar.search | true | Enable search-field in toolbar |
| toolbar.navigation | true | Enable navigation-drawer in toolbar |
| css | true | Load theme's CSS |
| js | true | Load theme's JS |
| itemize | true | Assign indices to paragraphs |
| linked_data | true | Generated Linked Data |
| highlighter | true | Highlight code |
| highlighter_theme | enlighter | Theme for highlighter |
| components | [List] | List of components to enable |
| router | true | Enable dynamic routes |
| routes | [Dict] | Key-value list of routes |
| api | [Dict] | Hierarchical key-value list of classes to use |
| flexsearch | [Dict] | Options for FlexSearch |
| flexsearch.enabled | true | Enable FlexSearch |

## Installation

Expand Down

0 comments on commit bb239ee

Please sign in to comment.