Commit graph

71 commits

Author SHA1 Message Date
Mohamed Wageh
ca4290e697 Automatically generate Table of Contents for each page (#376)
Closes #24.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/376
Co-authored-by: Mohamed Wageh <oatbiscuits@proton.me>
Co-committed-by: Mohamed Wageh <oatbiscuits@proton.me>
2023-12-11 17:32:09 +00:00
oatbiscuits
f0408b2c6a Add documentation for Forgejo CI Actions runner (#369)
This should solve #318.

Helped-by: Linus Groh <mail@linusgroh.de>
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-by: Linus Groh <mail@linusgroh.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/369
Co-authored-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
Co-committed-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
2023-12-07 16:58:07 +00:00
Gusted
1925a19f11 Better placeholder contrast for search input (#375)
Increase the contrast of the placeholder text in the search input, so it's actually readable.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/375
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2023-12-01 22:26:53 +00:00
oatbiscuits
55a504e33a Add search functionality (#370)
This should solve #23.

This is a fully static search implementation powered by [Pagefind](https://pagefind.app/).

In terms of UI, I found and implemented a section in the sidebar for searching the documentation. It was hidden presumably waiting for implementation. It mentioned using the slash (/) key for searching, so I implemented the hotkey as well.

I made the indexing command required by Pagefind run after Eleventy finishes building using the `.after` hook.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/370
Co-authored-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
Co-committed-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
2023-11-30 21:33:22 +00:00
Alex
966404aa5c Using Security keys on Codeberg (#367)
This PR adds docs on WebAuthn usage on Codeberg. It attempts to cover:
- using WebAuthn as a 2FA option on web logins
- using FIDO2 over SSH using the OpenSSH client

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/367
Co-authored-by: Alex <alex@blueselene.com>
Co-committed-by: Alex <alex@blueselene.com>
2023-11-28 20:57:37 +00:00
Andre601
b234b71bb7 Create new admonition boxes (#337)
Related issue: https://codeberg.org/Codeberg/Documentation/issues/330

This is my attempt at adding admonition-like boxes to the documentation. The goal is to make important stuff stand out more (especially warnings and alike).

The system uses a custom `<admonition>` box which allows classes for further customization. I.e. `<admonition class="warning">` to display a warning box.

I first wanted to make individual boxes (`<warning>`, `<note>`, ...) but decided against it, as it would've created a lot of duplicate CSS.

The CSS is designed in such a way that the first paragraph of the box is made bold (font-weight 700) while any subsequent ones are not.

The following forms of admonitions are included:
- Info (default)
- Note
- Tip
- Warning

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/337
Co-authored-by: Andre601 <github@andre601.ch>
Co-committed-by: Andre601 <github@andre601.ch>
2023-09-18 15:17:17 +00:00
Panagiotis "Ivory" Vasilopoulos
a9d53ca7cb Add documentation for Keycloak (#316)
Simple guide for using Keycloak with Codeberg based on the instructions
provided by Shane Engelman in Codeberg's Matrix chat.

Co-authored-by: shane <contact@shane.gg>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/316
2023-07-15 20:49:21 +00:00
f0sh
1984032bdd Add improvements to the Documentation according to open issues (#314)
Tried to close some open issues in the issue tracker by submitting the following changes as my first contribution to Codeberg:

 - added list on every section index page, should fix #63
 - added webhooks documentation, should fix #282
 - described behaviour of a limited user profile, should fix #279
 - added further explanation to 2fa section, according to Codeberg/Documentation#268, should fix #268
 - added codeberg badge generator to first-repository description, should fix #39
 - added dns record description to custom-domains, should fix #302
 - added description how to use 2fa with git, should fix #278
 - added and updated repo migration service description, should fix #312

Feedback highly appreciated.

Co-authored-by: f0sh <f0sh@mailbox.org>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/314
Co-authored-by: f0sh <f0sh@noreply.codeberg.org>
Co-committed-by: f0sh <f0sh@noreply.codeberg.org>
2023-07-08 16:27:44 +00:00
JakobDev
ff8910c5ee Add Documentation for Codeberg Translate (#300)
This is a simple documentation for Codeberg Translate. I think it can be improved in some points (especially the wording), but it should be a good start.

Closes: https://codeberg.org/Codeberg/Documentation/issues/273
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/300
Co-authored-by: JakobDev <jakobdev@gmx.de>
Co-committed-by: JakobDev <jakobdev@gmx.de>
2023-07-04 21:02:20 +00:00
Panagiotis "Ivory" Vasilopoulos
8fe5dd27d6 Improve clarity of wiki documentation (#305)
Fixes https://codeberg.org/Codeberg/Community/issues/1001#issuecomment-890160

Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/305
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <n0toose@noreply.codeberg.org>
Co-committed-by: Panagiotis "Ivory" Vasilopoulos <n0toose@noreply.codeberg.org>
2023-06-23 01:06:16 +00:00
JakobDev
448fd740df Add Documentation for integrating with Read the Docs (#289)
This adds a Documentation for connecting Codeberg to [Read the Docs](https://readthedocs.org/). English is not my native Language, so there may be a few things that could be written better.

Co-authored-by: René Wagner <rwa@clttr.info>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/289
Co-authored-by: JakobDev <jakobdev@gmx.de>
Co-committed-by: JakobDev <jakobdev@gmx.de>
2023-02-24 19:37:22 +00:00
Felipe Leopoldo Sologuren Gutiérrez
98c40b8a07 Fixing broken links (#267)
Changes:
 * Fallback images links are all lowercase now.
 * Fix html redirect (meta tag http-equiv redirect) from ```/git/clone-commit-via-http ```to ```/git/clone-commit-via-web```.
 * Added protocol to an email link.
 * Fix some pages links.

To detect broken links I used wget:

```
wget --spider --recursive --level=0 --debug -e robots=off --base=http://localhost:8080 http://localhost:8080 2>&1 | grep ^Found\ [0-9]*\ broken\ link
```

However, wget detects html redirects (meta tag http-equiv refresh) as false positive.

If broken links have found, then the referer header will be searched for find out where they are:
```
wget --spider --recursive --level=0 --save-headers --debug -e robots=off --base=http://localhost:8080 http://localhost:8080 2>&1 | less
```

Co-authored-by: fsologureng <sologuren@estudiohum.cl>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/267
Co-authored-by: Felipe Leopoldo Sologuren Gutiérrez <fsologureng@noreply.codeberg.org>
Co-committed-by: Felipe Leopoldo Sologuren Gutiérrez <fsologureng@noreply.codeberg.org>
2022-10-03 21:35:01 +02:00
jklippel
5f022adfc6 Initial version of a Markdown documentation (#221)
Add initial version of a Markdown documentation to explain Markdown to new contributors. Also provides a styleguide to guide to a consistent use of the Markdown markup within Codeberg.

Fixes #59

Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/221
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
2022-04-23 21:18:08 +02:00
fnetx
619aa91f52
Alignment in footer 2022-01-27 15:30:23 +01:00
lukaskluge
155db25dd0 reduce line width of content (#184)
Reduces line width in main text area to increase readability

fixes #183

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/184
Co-authored-by: lukaskluge <lukaskluge@noreply.codeberg.org>
Co-committed-by: lukaskluge <lukaskluge@noreply.codeberg.org>
2022-01-27 14:55:58 +01:00
n
f77fc97525 Add margin-top to lists 2021-11-21 20:49:52 +09:00
n
4fcfcfdc8d Fix wide margins in code blocks 2021-08-12 18:30:07 +09:00
n
170914185d Add anchor links to headings (#159)
This PR adds anchor links to any markdown headings. It also replaces any hacky workarounds used previously.

Closes #83.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/159
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-08-09 11:59:36 +02:00
n
190be05ba4 Update style for ul for consistency 2021-07-27 01:49:04 +09:00
n
ae684fbad4 Migrate to Codeberg Design Kit (#132) (#149)
TODO:
- [x] Hide navbar items on small screens
- [x] Fix `<blockquote>` rendering
- [x] Fix `<code>` rendering
- [ ] LibreJS Compatibility

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/149
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-07-26 12:07:23 +02:00
René Wagner
837a168192
move wiki to "getting started" section
reformat some paragraphs
2021-06-20 09:19:42 +02:00
René Wagner
68563215a4
complete usage of web & git cli for wiki updates
add screenshot of page management functions in web view
2021-06-16 19:49:58 +02:00
n
d33e360dbc Expand repo migration guide (#142)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/142
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-06-14 12:22:36 +02:00
n
6f0e575610 Complete Matrix integration guide 2021-05-15 16:19:47 +09:00
unknown
f4a983d307 add dark section (#121)
It is a dark css theme that almost match the dark arc-theme of Codeberg.
https://codeberg.org/unknown/dark_theme_codeberg_documentation

Co-authored-by: unknown <code@zaclys.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/121
Co-authored-by: unknown <unknown@noreply.codeberg.org>
Co-committed-by: unknown <unknown@noreply.codeberg.org>
2021-05-13 14:57:34 +02:00
n
f4feca6984 Added screenshot and rewrote part of tags article 2021-03-06 18:51:08 +01:00
tastytea
c0e7c4f0ae
Add default colors for background, text and hyperlinks.
Colors for hyperlinks are taken from
<https://html.spec.whatwg.org/multipage/rendering.html#phrasing-content-3>.

Fixes: #104
2020-10-28 20:43:12 +01:00
Lucas Hinderberger
f94bd91090 Merge branch 'prepare-merge' 2020-10-23 10:04:51 +02:00
Ivan Calandra
b4351c7db1 Changes required by lhinderberger 2020-10-23 09:49:44 +02:00
Ivan Calandra
d5af50bcca Update for Git 2.29.0 on Win10 2020-10-20 17:29:41 +02:00
Lucas Hinderberger
84378a22ea Implemented collapsing sub-menus - closes #93 2020-10-17 19:32:06 +02:00
Lucas Hinderberger
5e2a1ce0e8 Merge pull request 'Collaborators and Organizations' (#82) from ivan-paleo/Documentation:collabo-orga into master
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/82
2020-10-16 17:17:28 +02:00
Ivan Calandra
b67169ef6f More details about installation on Win
- Select components (icon, updates)
- Choose credential helper
- With screenshots
2020-10-16 10:19:05 +02:00
Ivan Calandra
c2d02b6094 personal access token for HTTP push 2020-10-13 16:25:26 +02:00
Ivan Calandra
28fb6f7147 Changes requested by lhinderberger 2020-10-04 20:44:27 +02:00
Ivan Calandra
1b790bade5 Add webP images 2020-10-04 20:44:27 +02:00
Ivan Calandra
fcc84e58e2 Install Git Win10 2020-10-04 20:44:27 +02:00
n
cccc050ac0 Remove image from first steps article (#52) 2020-10-03 16:35:35 +09:00
Lucas Hinderberger
915bad8125 Fixes #89 2020-10-03 00:16:17 +02:00
Ivan Calandra
b4f81deba2 2nd round of edits (not finalized) 2020-10-01 18:46:19 +02:00
ivan-paleo
d2bc1a8c6d Citable Code (#81)
Co-authored-by: Ivan Calandra
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/81
2020-09-30 12:26:08 +02:00
Lucas Hinderberger
0788c1aa65 First Repository Article (#79)
Co-authored-by: Ivan Calandra <12525997+ivan-paleo@users.noreply.github.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/79
2020-09-30 04:40:37 +02:00
Ivan Calandra
59a1bd21af Git-related parts of the web interface (#78)
Co-authored-by: Ivan Calandra <12525997+ivan-paleo@users.noreply.github.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/78
2020-09-30 04:21:35 +02:00
Ivan Calandra
9ceb5b379a invite-collaborators.md
Changes requested by lhinderberger
2020-09-29 16:45:55 +02:00
Ivan Calandra
cccdcfde89 Changes requested by lhinderberger 2020-09-29 11:22:52 +02:00
Ivan Calandra
acb7c098c1 Manage organization 2020-09-24 09:42:28 +02:00
Ivan Calandra
7b8042a9b3 Invite collaborators and Create organization 2020-09-23 17:32:27 +02:00
Lucas Hinderberger
fc572cc326 Smaller font size for mobile second-level menu 2020-09-20 14:21:02 +02:00
Lucas Hinderberger
807f55eb3b Closes #70 - Added overlay when menu is open 2020-09-20 14:19:20 +02:00
Lucas Hinderberger
81225e6b2a Fixes #72 2020-09-20 13:17:42 +02:00