This should resolve issue #327 opened by @n0toose
I have written a little bit of example, how do I see it
Co-authored-by: I <igor@its.rel.pl>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/406
Co-authored-by: Igor <309631@noreply.codeberg.org>
Co-committed-by: Igor <309631@noreply.codeberg.org>
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>
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>
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>
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>
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
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>
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>
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:8080http://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:8080http://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>
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>
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>
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>
Gusted