Contributions

Contributions #

This page explains how you can contribute to the XS-Leaks wiki and acknowledges the users who have contributed content.

Contribution guidelines #

The article source files reside in the /content directory in the wiki repository.

You can make changes to articles in various ways:

Pull requests #

In order to submit a pull request:

  1. Fork the repository.
  2. Make changes there and place them into a pull request.
  3. Submit the pull request of the branch to master in the main folder.

If you are not sure about the folder structure, you can look up how other articles were written.

Direct edits #

Under every article, there is an Edit this article anchor which redirects you straight to the GitHub editor.

Github issues #

If neither of the above options work for you, we’d appreciate if you created a new issue in the main wiki repository where you can explain the improvement, issue, or any other comment you have regarding the current version of the wiki.

Local deployment #

The wiki is built using the Hugo framework.

You can run a local environment by following these steps:

  1. Install the Hugo Framework, extended version > 0.68.
  2. Clone this repo.
  3. Run hugo server --minify in the root directory.
  4. Open your browser and go to http://localhost:1313 (or as indicated by the Hugo output).

Wiki theme #

We use the Hugo Book Theme with custom modifications.

Custom hint shortcode #

We modified the default Hints used by the theme; the modified boxes are listed below:

info

This is an Info box for the {{< hint info >}} shortcode.

note

This is a Note box for the {{< hint note >}} shortcode.

example

This is an Example box for the {{< hint example >}} shortcode.

tip

This is a Tip box for the {{< hint tip >}} shortcode.

important

This is an Important box for the {{< hint important >}} shortcode.

warning

This is a Warning box for the {{< hint warning >}} shortcode.

Original style #

The original hint style can be used by adding a third parameter, noTitle, to the shortcode, e.g.:

{{< hint example noTitle >}}

Acknowledgements #

We would like to thank the following users who contributed to this XS-Leaks wiki:

Manuel Sousa, terjanq, Roberto Clapis, David Dworken, NDevTK, 1lastBr3ath

In addition, we would also like to acknowledge the users who contributed to the predecessor of the current XS-Leaks wiki:

Eduardo' Vela" <Nava> (sirdarckcat), Ron Masas, Luan Herrera, Sigurd, larson reever, Frederik Braun Masato Kinugawa, sroettger

And finally, our thanks go to all other amazing researchers that participate in sharing and exploring the depths of XS-Leaks!