aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/doc/advanced/customizing-gitea.en-us.md
Commit message (Collapse)AuthorAgeFilesLines
* Restructure documentation. Now the documentation has installation, ↵Lunny Xiao2023-03-231-372/+0
| | | | | | | | | | | | | | | | | | | | | | administration, usage, development, contributing the 5 main parts (#23629) - **Installation**: includes how to install Gitea and related other tools, also includes upgrade Gitea - **Administration**: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI - **Usage**: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others. - **Development**: includes how to integrate with Gitea's API, how to develop new features within Gitea - **Contributing**: includes how to contribute code to Gitea repositories. After this is merged, I think we can have a sub-documentation of `Usage` part named `Actions` to describe how to use Gitea actions --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com>
* Replace Less with CSS (#23481)silverwind2023-03-141-1/+1
| | | | | | | | | | | | Ran most of the Less files through the Less compiler and Prettier and then followed up with a round of manual fixes. The Less compiler had unfortunately stripped all `//` style comments that I had to restore (It did preserve `/* */` comments). Other fixes include duplicate selector removal which were revealed after the transpilation and which weren't caught by stylelint before but now are. Fixes: https://github.com/go-gitea/gitea/issues/15565
* Update documentation for the new YAML label file format (#23020)JonRB2023-03-071-1/+14
| | | | | | | | | | | | update documentation to include an overview of the yaml label template that is part of PR #22976 Signed-off-by: Jon Roadley-Battin <jon.roadleybattin@gmail.com> --------- Co-authored-by: Yarden Shoham <hrsi88@gmail.com> Co-authored-by: Lauris BH <lauris@nix.lv> Co-authored-by: John Olheiser <john.olheiser@gmail.com> Co-authored-by: delvh <dev.lh@web.de>
* Fix PlantUML example in document (#21142)wxiaoguang2022-09-111-5/+5
| | | | | | | The document was written before Gitea 1.15. Now Gitea uses `/assets` sub-directory (#15219). Close #21023 * #21023
* Add markdownlint (#20512)silverwind2022-07-281-6/+6
| | | | Add `markdownlint` linter and fix issues. Config is based on the one from electron's repo with a few rules relaxed.
* Updated dead link to Madeleine.js source (#20322)BurritoVoid2022-07-111-1/+1
|
* Fix custom folder name in customization docs (#20148)Jorge Ou2022-06-271-2/+2
|
* Add the possibility to allow the user to have a favicon which differs from ↵Jan-Eric Schober2022-05-231-4/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | the main logo (#18542) * Changed the filename of the favicon SVG This allows the user to have a favicon which differs from the logo. * Added favicon.svg This is needed to accommodate the changes for allowing the user to have a differing logo and favicon * Adjusted page to accommodate what icon is used as favicon * Added functionality to also generate the favicon.svg via generate-images.js * Adjusted the description for the new favicon compatibility Co-authored-by: silverwind <me@silverwind.io> * Updated generate-images.js to generate favicons from a separate favicons.svg file This belongs to PR #18542. * Added description on how custom favicons can be generated * Replaced space indents with tabs * Synced changes with current state of the file * Synced changes with current state of the file Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: Lauris BH <lauris@nix.lv>
* Remove `RequireHighlightJS` field, update plantuml example. (#19615)wxiaoguang2022-05-051-7/+10
|
* Remove legacy unmaintained packages, refactor to support change default ↵wxiaoguang2022-04-031-0/+2
| | | | | | | | | | locale (#19308) Remove two unmaintained vendor packages `i18n` and `paginater`. Changes: * Rewrite `i18n` package with a more clear fallback mechanism. Fix an unstable `Tr` behavior, add more tests. * Refactor the legacy `Paginater` to `Paginator`, test cases are kept unchanged. Trivial enhancement (no breaking for end users): * Use the first locale in LANGS setting option as the default, add a log to prevent from surprising users.
* Fix various typos of software names (#18083)qwerty2872021-12-241-1/+1
| | | | | | | | | | | | | | | | * `git` -> `Git` * `Github` and `github` -> `GitHub` * `crowdin` -> `Crowdin` * `git-lfs` -> `Git LFS` * `githooks`, `git hooks`, `git-hooks` -> `Git Hooks` * `discord` -> `Discord` * `2fa` -> `2FA` * `gitlab` and `Gitlab` -> `GitLab` * `web hook` -> `webhook` * `linux` -> `Linux` * `sqlite` -> `SQLite` * `MYSQL` and `mysql` -> `MySQL` * rename refs to `master` branch -> `main` * Fix English grammar
* Docs: replace `gitea` with `Gitea` (#17838)qwerty2872021-11-281-3/+3
| | | | Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Detect dark theme via css variable (#17800)ThetaDev2021-11-251-0/+3
| | | | | | | * detect dark theme via css variable * minor refactor, add documentation If your custom theme is considered a dark theme, set the global css variable `--is-dark-theme` to `true`. This allows gitea to adjust the Monaco code editor's theme accordingly.
* Use light/dark theme based on system preference (#17051)Gwyneth Morgan2021-09-271-1/+1
| | | | | | | | Add a new default theme `auto`, which will automatically switch between `gitea` (light) and `arc-green` (dark) themes depending on the user's operating system settings. Closes: #8183
* update theme doc (#16860)Patrick Schratz2021-08-291-2/+15
|
* docs: fix various typos and translate to french (#16477)Antoine Goutenoir2021-07-181-1/+1
| | | Co-authored-by: 6543 <6543@obermui.de>
* Update documentation to reflect #15219 (#16442)zeripath2021-07-151-7/+7
| | | | | | | | | The move to render custom/public as within /assets in #15219 missed updating several documentation pages. This PR updates this documentation. Signed-off-by: Andrew Thornton <art27@cantab.net>
* Fix typo in customizing-gitea.en-us.md (#16362)冯天书2021-07-071-1/+1
| | | Fixed a type in a URL in PlantUML code example in `customizing-gitea.en-us.md`.
* Fix docs assets link (#16337)Lunny Xiao2021-07-041-1/+1
|
* Improve logo customization docs (#15754)silverwind2021-05-071-13/+9
| | | | | | | | | * Improve logo customization docs * Update docs/content/doc/advanced/customizing-gitea.en-us.md * Update docs/content/doc/advanced/customizing-gitea.en-us.md Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* update branch in CI and docs (#15631)techknowlogick2021-05-041-7/+7
|
* Fix a broken link in customizing-gitea.en-us.md (#15543)Raphael Kruse2021-04-191-1/+1
|
* Note that all template directories are relative to the `CustomPath` ↵Jake Howard2021-01-191-27/+28
| | | | | | | | | | | | | configuration, not a `custom` directory inside it (#14399) * Note that all template directories are relative to the `CustomPath` configuration, not a `custom` directory inside it. This is a minor clarification, which makes locating where the templates need to be much easier * Note that it's possible to read the `GITEA_CUSTOM` value from the admin * Use "$GITEA_CUSTOM" as placeholder It's more obvious it's a variable and not a typo
* Consolidate Logos and update README header (#14136)silverwind2021-01-011-2/+11
| | | | | | | | | | | | | | | | | | | | * Consolidate Logos and update README header - Remove unused `logo-lg.png`, `logo-sm.png` and `logo-192.png`. - Consolidate `favicon.svg` and `logo.svg` to just `logo.svg`. - Remove Safari Mask icon, it seems to work fine with just `favicon.png` (no SVG support). - Remove Fluid Icon. It only served Firefox and SVG works just fine there. - Update customization instructions. - Update README.md to use SVG icon, increase logo size and center it and badges. * Update README_ZH.md Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> * Update README_ZH.md Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* gitea png to logo (#13974)Kyle D2020-12-181-0/+4
| | | | | | | | | | | * gitea png to logo.svg * gitea safari svg to logo * minify svgs * Update english docs * Update missing section on customizing logo
* Reformat docs (#13897)Patrick Schratz2020-12-091-26/+40
| | | | Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lauris BH <lauris@nix.lv>
* Added Table of Contents to long documentation pages (#13890)65432020-12-071-0/+4
| | | | | | | | * Redo #13836 with new shortcode (https://gitea.com/gitea/theme/pulls/90) * add Api Usage Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Use CSS Variables for fonts, remove postcss-loader (#13204)silverwind2020-10-191-0/+12
| | | | | | | | | | | | | * Use CSS Variables for fonts, remove postcss-loader - Use CSS variables for fonts, making the fonts easier to customize - Remove postcss-loader, it's not doing anything useful and is actually applying strange transforms on our CSS. Fixes: https://github.com/go-gitea/gitea/issues/11045 * introduce helper variable, mark documented vars * work around case issue by always quoting specific fonts
* Add mermaid JS renderer (#12334)silverwind2020-07-271-39/+0
| | | | | | | | | | | | | | | | | | | * Add mermaid JS renderer For feature parity with GitLab. Tested in files, issues, wiki, editor. arc-green only does an inversion because the renderer seems to like to render white backgrounds on boxes. Ref: https://github.com/go-gitea/gitea/issues/3340 Fixes: https://github.com/go-gitea/gitea/issues/12307 * add feature entry, switch to neutral theme, remove border * add bindFunctions support * remove unnecessary border-radius Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Rename custom/conf/app.ini.sample to custom/conf/app.example.ini for better ↵Lunny Xiao2020-06-171-1/+1
| | | | | | | | | | | syntax light on editor (#11926) * Rename custom/conf/app.ini.sample to custom/conf/app.sample.ini for better syntax light on editor * rename to app.example.ini * per @6543 's comment, update all references on docs Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Add documentation to display STL preview (#11181)Antoine GIRARD2020-04-221-0/+83
| | | | | | | | | | | * Update customizing-gitea.en-us.md * Update customizing-gitea.en-us.md * only load assets when needed * remove useless var * fix missing 'i' modifier
* [feature] provide `OwnerName` field for README template (#10981)j.yao.SUSE2020-04-061-1/+1
| | | | Co-Authored-By: 6543 <6543@obermui.de> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* [Docs] Add Note to Readme-Template about Variable Espansion (#10983)65432020-04-061-3/+6
| | | | | * add note with Espansion VarNames * add context of Name
* Implement "embedded" command to extract static resources (#9982)guillep2k2020-02-021-6/+13
| | | | | | | | | | | | | | | | | | | | | | | * draft * Implement extract command * Fix nits and force args on extract * Add !bindata stub, support Windows, fmt * fix vendored flag * Remove leading slash for matching * Add docs * Fix typos * Add embedded view command Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Add documentation how to render PlantUML in code blocks. (#9894)David Svantesson2020-01-211-1/+35
| | | | | | | | | | | | | * Add documentation how to render plantuml in code blocks. * Review comments * Apply suggestions from code review Co-Authored-By: guillep2k <18600385+guillep2k@users.noreply.github.com> Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com> Co-authored-by: zeripath <art27@cantab.net>
* fix broken link (#9901)zeripath2020-01-201-1/+1
| | | | Co-authored-by: Lauris BH <lauris@nix.lv>
* Add documentation to add Mermaid.js to Gitea (#9872)zeripath2020-01-201-2/+39
| | | | | | | | * Add documentation to add mermaid to Gitea * Update documentation Co-authored-by: Antoine GIRARD <sapk@users.noreply.github.com>
* Add Privacy Policy and Terms of Service Page (#9513)Bagas Sanjaya2020-01-141-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add privacy policy page and link * Add TOS page and link * Add update date * [Docs] Add customizing PP and TOS * Separate h2 user-generated content with its paragraph * Reimplement Privacy Policy The document is inspired from GitHub. * Refactor to contrib * [Docs] Mention how to add legal pages * Reimplement Terms of Service Adapted from GitHub * Update revision date * Rename to mark as sample file * Apply suggestion from @sapk Co-Authored-By: Antoine GIRARD <sapk@users.noreply.github.com> * Apply suggestion from @sapk Use absolute link instead Co-Authored-By: Antoine GIRARD <sapk@users.noreply.github.com> * Apply suggestion from @zeripath Change `Last Updated` element to `<h4>` Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestion from @zeripath Close this `<li>` element instance Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestion from @zeripath Intentionally grammar fix Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestion from @zeripath Information grammar Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestion from @zeripath Cannot guarantee absolute security... Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestion from @zeripath Use `<h4>` element for last updated date Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestion from @zeripath Remove trailing `</p>` at the end of API clause Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestion from @zeripath Migrate privacy email domain to Your Gitea Instance Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestions from @zeripath Remove `<p>` container for `<ol>` definitions Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestions from @zeripath Remove `<p>` container that contain `<ol>` user-generated content Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestions from @zeripath Remove `<p>` container for private repositories `<ol>` listing Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestions from @zeripath Migrate remaining email domains to Your Gitea Instance Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestion from @zeripath Offer support Co-Authored-By: zeripath <art27@cantab.net> * Apply suggestion from @zeripath Change "Your Gitea Instance" references to match your situation and Gitea project disclaimer Co-Authored-By: zeripath <art27@cantab.net> * Reword transmission data to reflect hosting on third-party provider * Reword Analytics clause to reflects that not all Gitea instances deploy analytics OOTB * Remove `<p>` container from account terms * Migrate support email on tos to your-gitea-instance * Reword Tracking and Analytics clause for OOTB case * [Docs] Append privacy.html to cp destination * Apply suggestion from @6543 Create or append to footer template Co-Authored-By: 6543 <6543@obermui.de> * Apply suggestion from myself @6543 suggest replacing this `cp` line (which assumed that Gitea sources are available) with `wget` to GitHub raw link. At the time of writing this, this returned 404, but when this PR has been merged, this should get the actual page. * Apply suggestions from @6543 1. Add gpg key to profile information 2. Add Git repos to list of User Personal Information 3. Comment out responsibility for sensitive information Co-Authored-By: 6543 <6543@obermui.de> Co-authored-by: Antoine GIRARD <sapk@users.noreply.github.com> Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: 6543 <6543@obermui.de>
* More extensive robots.txt docs (#9566)8ctopus2020-01-071-6/+0
|
* Add footer extra links template (#9576)Bagas Sanjaya2020-01-031-2/+2
| | | | | | | | | | | | | | | * Add footer extra links template * [Docs] Update to mention extra links footer template * Commit suggestion from @davidsvantesson Co-Authored-By: David Svantesson <davidsvantesson@gmail.com> * Move template placement to right side of footer Co-authored-by: David Svantesson <davidsvantesson@gmail.com> Co-authored-by: Lauris BH <lauris@nix.lv>
* Add warning to docs in order to avoid template mismatches (#9411)pseudocoder2019-12-181-1/+1
| | | | | | | | | | * DOCS: add mention of swagger api reference It's(swagger api link) mentioned vaguely in the FAQ but IMHO missing from API usage page. * Add warning to avoid template mismatches Related to https://github.com/go-gitea/gitea/issues/9320
* [Feature] Custom Reactions (#8886)65432019-12-011-0/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add [ui] Reactions * move contend check from form to go functions * use else if * check if reaction is allowed only on react (so previous custom reaction can be still removed) * use $.AllowedReactions in templates * use ctx.Flash.Error * use it there too * add redirection * back to server error because a wrong reaction is a template issue ... * add emoji list link * add docs entry * small wording nit suggestions from @jolheiser - thx * same reactions as github * fix PR reactions * handle error so template JS could check * Add Integrations Test * add REACTIONS setting to cheat-sheet doc page
* [Docs] add explicit info about customization of homepage (#8694)65432019-10-281-1/+7
| | | | | | | | | | * first draft * Update docs/content/doc/advanced/customizing-gitea.en-us.md Co-Authored-By: zeripath <art27@cantab.net> * add notice to restart
* Remove unnecessary backslash (#8249)John Olheiser2019-09-201-1/+1
|
* Add section about customizing mail (#7419)Sandro Santilli2019-07-111-0/+14
| | | See https://github.com/go-gitea/gitea/issues/6037
* Make CustomPath, CustomConf and AppWorkPath configurable at build (#6631)zeripath2019-04-291-7/+17
|
* Copyedit docs (#6275)Aidan Fitzgerald2019-03-091-1/+1
|
* Doc updates for customization and installation. (#6176)John Olheiser2019-02-281-2/+38
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Doc updates and changing default sqlite DB path Signed-off-by: jolheiser <john.olheiser@gmail.com> * Update customizing locales and THEMES Signed-off-by: jolheiser <john.olheiser@gmail.com> * Add link to templates directory Signed-off-by: jolheiser <john.olheiser@gmail.com> * Add portion for final step of running Gitea Signed-off-by: jolheiser <john.olheiser@gmail.com> * Add recommended to service file usage Signed-off-by: jolheiser <john.olheiser@gmail.com> * Removed DB path change, moving to another PR Updated doc sentence structure Signed-off-by: jolheiser <john.olheiser@gmail.com> * Revert change to template wording Signed-off-by: jolheiser <john.olheiser@gmail.com> * Move recommended run-type to top
* Clean up docs (#5274)techknowlogick2018-11-041-1/+5
| | | | | | | | | | | | * make docs more clear * make docs more clear * Add analytics * Update customizing-gitea.en-us.md * Update app.ini.sample
* Fix doc typo (#4517)William Le Pommelet2018-07-261-1/+1
| | | | | | | | | | | | * fix language list Standardized the languages' names within the list displayed when picking up a language at the bottom of the webpages * typo fix a typo into documentation (template rather than templete) * fix languages list
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-09 22:10:50 +0000