Beyond coding. We forge. (Code of Conduct: https://codeberg.org/forgejo/code-of-conduct)
Go to file
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>
2022-09-14 00:33:37 +08:00
.gitea Issue template form (#16349) 2021-09-15 20:33:13 +03:00
.github update discord invite (#19907) 2022-06-07 11:40:27 -04:00
assets Generate go-licenses during tidy again (#21108) 2022-09-09 11:33:01 -04:00
build Generate go-licenses during tidy again (#21108) 2022-09-09 11:33:01 -04:00
cmd test: use T.TempDir to create temporary test directory (#21043) 2022-09-04 16:14:53 +01:00
contrib Kd/ci playwright go test (#20123) 2022-09-02 15:18:23 -04:00
custom/conf Add KaTeX rendering to Markdown. (#20571) 2022-09-14 00:33:37 +08:00
docker Fix the mode of custom dir to 0700 in docker-rootless (#20861) 2022-08-19 11:05:07 -04:00
docs Add KaTeX rendering to Markdown. (#20571) 2022-09-14 00:33:37 +08:00
models Fix various typos (#21103) 2022-09-07 14:40:36 -04:00
modules Add KaTeX rendering to Markdown. (#20571) 2022-09-14 00:33:37 +08:00
options [skip ci] Updated translations via Crowdin 2022-09-12 00:20:40 +00:00
public Update JS dependencies and lint (#21144) 2022-09-11 17:34:38 +02:00
routers Show .editorconfig errors in frontend (#21088) 2022-09-12 00:16:56 +02:00
services Allow poster to choose reviewers (#21084) 2022-09-09 18:27:47 +01:00
snap switch to node18 for snapcraft 2022-08-18 12:25:50 -04:00
templates Use form for admin purge user (#21070) 2022-09-12 21:52:17 +01:00
tests Remove fomantic image module (#21145) 2022-09-12 17:08:46 +08:00
tools Remove legacy +build: constraint (#19582) 2022-05-02 23:22:45 +08:00
web_src Add KaTeX rendering to Markdown. (#20571) 2022-09-14 00:33:37 +08:00
.air.toml Fix make watch for generated files (#20794) 2022-08-14 22:22:09 +01:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.drone.yml chore(security): Support Go Vulnerability Management (#21139) 2022-09-11 15:02:18 +08:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Update JS dependencies and lint (#21144) 2022-09-11 17:34:38 +02:00
.gitattributes Move eslintrc/stylelintrc to non-deprecated extensions (#20110) 2022-06-24 14:09:53 +02:00
.gitignore Add go licenses to licenses.txt (#21034) 2022-09-04 00:20:46 +02:00
.golangci.yml Add badge capabilities to users (#20607) 2022-08-18 02:25:25 +03:00
.ignore Add some .ignore entries (#18296) 2022-01-16 17:26:15 +00:00
.lgtm refactor: ignore LGTM from author of pull request. (#3283) 2018-01-02 06:13:49 -06:00
.markdownlint.yaml Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.npmrc Stop packaging node_modules in release tarballs (#15273) 2021-04-09 01:08:14 -04:00
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.stylelintrc.yaml Move eslintrc/stylelintrc to non-deprecated extensions (#20110) 2022-06-24 14:09:53 +02:00
BSDmakefile Add BSDmakefile to prevent errors when make is called under FreeBSD (#4446) 2018-07-16 20:45:51 +02:00
build.go Remove legacy +build: constraint (#19582) 2022-05-02 23:22:45 +08:00
CHANGELOG.md Changelog 1.17.1 (#20833) (#20919) 2022-08-23 10:02:16 +08:00
CONTRIBUTING.md Kd/ci playwright go test (#20123) 2022-09-02 15:18:23 -04:00
DCO follow the advisor: add DCO and some improvements 2016-11-04 16:43:41 +08:00
Dockerfile Switch to building with go1.19 (#20695) 2022-08-07 12:25:03 -04:00
Dockerfile.rootless Switch to building with go1.19 (#20695) 2022-08-07 12:25:03 -04:00
go.mod Add KaTeX rendering to Markdown. (#20571) 2022-09-14 00:33:37 +08:00
go.sum Update a few go dependencies (#21022) 2022-09-01 23:13:17 +02:00
jest.config.js Enable contenthash in filename for dynamic assets (#20813) 2022-08-23 20:58:04 +08:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
main.go Fix typo overrided -> overridden (#20687) 2022-08-06 20:54:26 -04:00
MAINTAINERS chore: add myself to maintainers (#21028) 2022-09-02 20:23:48 +08:00
Makefile chore(security): Support Go Vulnerability Management (#21139) 2022-09-11 15:02:18 +08:00
package-lock.json Add KaTeX rendering to Markdown. (#20571) 2022-09-14 00:33:37 +08:00
package.json Add KaTeX rendering to Markdown. (#20571) 2022-09-14 00:33:37 +08:00
playwright.config.js Kd/ci playwright go test (#20123) 2022-09-02 15:18:23 -04:00
README.md Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
README_ZH.md Fix English mistakes in some Markdown documents (#20274) 2022-07-14 19:15:35 +08:00
SECURITY.md Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
webpack.config.js Add KaTeX rendering to Markdown. (#20571) 2022-09-14 00:33:37 +08:00

Gitea

Gitea - Git with a cup of tea

View this document in Chinese

Purpose

The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service.

As Gitea is written in Go, it works across all the platforms and architectures that are supported by Go, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. You can try it out using the online demo. This project has been forked from Gogs since November of 2016, but a lot has changed.

Building

From the root of the source tree, run:

TAGS="bindata" make build

or if SQLite support is required:

TAGS="bindata sqlite sqlite_unlock_notify" make build

The build target is split into two sub-targets:

  • make backend which requires Go Stable, required version is defined in go.mod.
  • make frontend which requires Node.js LTS or greater and Internet connectivity to download npm dependencies.

When building from the official source tarballs which include pre-built frontend files, the frontend target will not be triggered, making it possible to build without Node.js and Internet connectivity.

Parallelism (make -j <num>) is not supported.

More info: https://docs.gitea.io/en-us/install-from-source/

Using

./gitea web

NOTE: If you're interested in using our APIs, we have experimental support with documentation.

Contributing

Expected workflow is: Fork -> Patch -> Push -> Pull Request

NOTES:

  1. YOU MUST READ THE CONTRIBUTORS GUIDE BEFORE STARTING TO WORK ON A PULL REQUEST.
  2. If you have found a vulnerability in the project, please write privately to security@gitea.io. Thanks!

Translating

Translations are done through Crowdin. If you want to translate to a new language ask one of the managers in the Crowdin project to add a new language there.

You can also just create an issue for adding a language or ask on discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord. For general translation questions there is a section in the docs. Currently a bit empty but we hope to fill it as questions pop up.

https://docs.gitea.io/en-us/translation-guidelines/

Crowdin

Further information

For more information and instructions about how to install Gitea, please look at our documentation. If you have questions that are not covered by the documentation, you can get in contact with us on our Discord server or create a post in the discourse forum.

We maintain a list of Gitea-related projects at gitea/awesome-gitea.

The Hugo-based documentation theme is hosted at gitea/theme.

The official Gitea CLI is developed at gitea/tea.

Authors

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

FAQ

How do you pronounce Gitea?

Gitea is pronounced /ɡɪti:/ as in "gi-tea" with a hard g.

Why is this not hosted on a Gitea instance?

We're working on it.

License

This project is licensed under the MIT License. See the LICENSE file for the full license text.

Screenshots

Looking for an overview of the interface? Check it out!

Dashboard User Profile Global Issues
Branches Web Editor Activity
New Migration Migrating Pull Request View
Pull Request Dark Diff Review Dark Diff Dark