lavender-legacy
/
gitea
7
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
gitea/docs
History
Alexander Scheel ee7df7ba8c Markdown: Sanitizier Configuration (#9075) 
* Support custom sanitization policy

Allowing the gitea administrator to configure sanitization policy allows
them to couple external renders and custom templates to support more
markup. In particular, the `pandoc` renderer allows generating KaTeX
annotations, wrapping them in `<span>` elements with class `math` and
either `inline` or `display` (depending on whether or not inline or
block mode was requested).

This iteration gives the administrator whitelisting powers; carefully
crafted regexes will thus let through only the desired attributes
necessary to support their custom markup.

Resolves: #9054

Signed-off-by: Alexander Scheel <alexander.m.scheel@gmail.com>

* Document new sanitization configuration

 - Adds basic documentation to app.ini.sample,
 - Adds an example to the Configuration Cheat Sheet, and
 - Adds extended information to External Renderers section.

Signed-off-by: Alexander Scheel <alexander.m.scheel@gmail.com>

* Drop extraneous length check in newMarkupSanitizer(...)

Signed-off-by: Alexander Scheel <alexander.m.scheel@gmail.com>

* Fix plural ELEMENT and ALLOW_ATTR in docs

These were left over from their initial names. Make them singular to
conform with the current expectations.

Signed-off-by: Alexander Scheel <alexander.m.scheel@gmail.com>
 		2019-12-07 14:49:04 -05:00
..
assets/js Implement documentation search (#8937) 2019-11-13 18:03:18 +00:00
content Markdown: Sanitizier Configuration (#9075) 2019-12-07 14:49:04 -05:00
layouts Implement documentation search (#8937) 2019-11-13 18:03:18 +00:00
scripts Fix building of docs with latest hugo version (#3856) 2018-04-28 23:46:05 +03:00
static Add CDNJS to script-src CSP (#8966) 2019-11-13 20:22:09 +00:00
.editorconfig Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
.gitignore Implement documentation search (#8937) 2019-11-13 18:03:18 +00:00
LICENSE Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
Makefile Ensure docs makefile downloads theme if failed before. (#3322) 2018-01-07 14:11:17 +02:00
README.md Update to docs README (#6221) 2019-03-01 15:39:30 -05:00
README_ZH.md CN translation of README (#5049) 2018-10-18 09:44:29 +08:00
config.yaml docs change gitea version to 1.10.1 (#9270) 2019-12-06 14:12:38 -05:00

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

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