Skip to content

docs: surface MathJax setup in configuration guide #918

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Samk13 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: surface MathJax setup in configuration guide #918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/operate/customize/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,19 @@ APP_DEFAULT_SECURE_HEADERS = {
}
```

### Mathematical formulas (MathJax)

To render mathematical formulas on record landing pages, configure MathJax in your `invenio.cfg`:

```python
THEME_MATHJAX_CDN = (
"//cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.2/es5/tex-mml-chtml.js"
"?config=TeX-AMS-MML_HTMLorMML"
)
```

Since MathJax is loaded from a CDN, make sure your Content Security Policy allows `cdnjs.cloudflare.com` in `APP_DEFAULT_SECURE_HEADERS`.

### Citation styles

InvenioRDM supports citations styles defined in the [CSL 1.0.1 specifications](https://docs.citationstyles.org/en/v1.0.1/specification.html). You can find the list of all possible citation styles [here](https://github.com/citation-style-language/styles/tree/v1.0.1).
Expand Down
2 changes: 1 addition & 1 deletion docs/releases/v13/version-v13.0.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ Here is a quick summary of the myriad of other improvements in this release:
- Following the [latest COUNTER spec](https://www.countermetrics.org/code-of-practice/), the [list of robots and machines](https://github.com/inveniosoftware/counter-robots) have been updated to ensure the stats are counted on human usage.
- Logging: the Flask root logger level has been changed from `undefined` to `DEBUG`. This enables all log messages to pass through by default, instead of being blocked. If you have implemented custom logging handlers, ensure that you have defined the logging level and verify your logging verbosity in deployed environments to avoid excessive logs.
- The issue related to storage quota per record for a given user has been solved. You can now define different storage quotas per record.
- MathJax: when enabled, it will now render mathematical formulas also in the landing page citation box, search results and request's comments pages.
- MathJax: when enabled, it will now render mathematical formulas also in the landing page citation box, search results and request's comments pages. See [Mathematical formulas (MathJax)](../../operate/customize/configuration.md#mathematical-formulas-mathjax) for configuration details.
- Easier link generation: it's now possible to use `from invenio_base import invenio_url_for` to generate API links in the UI application and vice versa. When configuring services, `from invenio_records_resources.services import EndpointLink` now replaces `Link` which establishes a single source of truth for links.
- ...and many more bug fixes!

Expand Down