You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
forgejo/docs
zeripath 88c2e24360
Add KaTeX rendering to Markdown. (#20571)
This PR adds mathematical rendering with KaTeX.

The first step is to add a Goldmark extension that detects the latex
(and tex) mathematics delimiters.

The second step to make this extension only run if math support is
enabled.

The second step is to then add KaTeX CSS and JS to the head which will
load after the dom is rendered.

Fix #3445

Signed-off-by: Andrew Thornton <art27@cantab.net>

Signed-off-by: Andrew Thornton <art27@cantab.net>
Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2 years ago
..
assets/js Add new JS linter rules (#17699) 3 years ago
content Add KaTeX rendering to Markdown. (#20571) 2 years ago
layouts docs: move search input to navbar (#20551) 2 years ago
scripts Fix building of docs with latest hugo version (#3856) 6 years ago
static Self-host cloudron image for docs (#13895) 4 years ago
.gitignore Support Issue forms and PR forms (#20987) 2 years ago
LICENSE Import docs into main repository (#2874) 7 years ago
Makefile follow redirect when fetching theme archive (#15986) 3 years ago
README.md Update to docs README (#6221) 5 years ago
README_ZH.md update discord link (#10455) 4 years ago
config.yaml update current stable version 2 years ago

README.md

Gitea: Docs

Join the chat at https://img.shields.io/discord/322538954119184384.svg

Hosting

These pages are hosted using netlifycms and get automatically updated on every push to the master branch.

Install

These pages use the Hugo static site generator. If you are planning to contribute you'll want to download and install Hugo on your local machine.

The installation of Hugo is out of the scope of this document, so please take the official install instructions to get Hugo up and running.

Development

To generate the website and serve it on localhost:1313 just execute this command and stop it with Ctrl+C:

make server

When you are done with your changes just create a pull request, after merging the pull request the website will be updated automatically.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

License

This project is under the Apache-2.0 License. See the LICENSE file for the full license text.

Copyright (c) 2016 The Gitea Authors <https://gitea.io>