Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mutantsan committed Sep 10, 2024
1 parent 741743f commit beaa2f2
Showing 1 changed file with 33 additions and 33 deletions.
66 changes: 33 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,39 +16,39 @@ It's still debatable if we need cache at all. Big resource processed with pygmen
Supported config options:

```yaml
- key: ckanext.pygments.supported_formats
type: list
description: Specify a list of supported formats
default: sql html xhtml htm xslt py pyw pyi jy sage sc rs rs.in rst rest md markdown xml xsl rss xslt xsd wsdl wsf json jsonld yaml yml dtd php inc rdf ttl js

- key: ckanext.pygments.max_size
type: int
description: Specify how many bytes we are going to render from file. Default to 1MB
default: 1048576

- key: ckanext.pygments.include_htmx_asset
description: Include HTMX asset
default: true
type: bool

- key: ckanext.pygments.default_theme
description: Default theme for preview
default: default

- key: ckanext.pygments.cache.enable
description: Enable cache
default: false
type: bool

- key: ckanext.pygments.cache.resouce_max_size
description: Specify what is the maximum size of the resource that we are going to cache
default: 20971520 # 20MB
type: int

- key: ckanext.pygments.cache.ttl
description: Specify the time to live of the cache
default: 7200 # 2 hours
type: int
- key: ckanext.pygments.supported_formats
type: list
description: Specify a list of supported formats
default: sql html xhtml htm xslt py pyw pyi jy sage sc rs rs.in rst rest md markdown xml xsl rss xslt xsd wsdl wsf json jsonld yaml yml dtd php inc rdf ttl js

- key: ckanext.pygments.max_size
type: int
description: Specify how many bytes we are going to render from file. Default to 1MB
default: 1048576

- key: ckanext.pygments.include_htmx_asset
description: Include HTMX asset
default: true
type: bool

- key: ckanext.pygments.default_theme
description: Default theme for preview
default: default

- key: ckanext.pygments.cache.enable
description: Enable cache
default: false
type: bool

- key: ckanext.pygments.cache.resouce_max_size
description: Specify what is the maximum size of the resource that we are going to cache
default: 20971520 # 20MB
type: int

- key: ckanext.pygments.cache.ttl
description: Specify the time to live of the cache
default: 7200 # 2 hours
type: int
```
## Tests
Expand Down

0 comments on commit beaa2f2

Please sign in to comment.