Skip to content

[EN] Wiki chart

CaptainHarlockSSX edited this page Jun 17, 2023 · 1 revision

As you can see, the wiki for now has two versions, a french one [FR] and an english one [EN]. You can navigate each of these using the sidebar.

To add something to the sidebar, you simply have to click on the pen in the top-right of it (which will actually edit the _Sidebar file)

Contributing

You made something, and you want to add it to the wiki? Just create a new page! The wiki uses markdown. Here are some tips to save you some time 👍

Add an image to the wiki

You can add an image to the wiki by dropping it in the text zone. GitHub will then automatically generate a file that'll be placed under https://github.com/Etoiles-ing/CCleaner_Project/assests/....

The main drawback of this method is that if you delete all references to said image, the image itself will be deleted (which isn't convenient at all when you're trying to write documentation!)

The solution we found consist of manually adding the images to the wiki, by uploading them to an assets folder: git clone https://github.com/Etoiles-ing/CCleaner_Project.wiki.git

Add your images, commit, and push!

Once done, you can then reference your images on any page using the following syntax:

[[/assets/ImageName.png]]

Dynamically changing the image depending on the current theme:

To have the image change depending on the current theme (light or dark), you can use the following syntax:

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="assets/dark_image.png">
  <source media="(prefers-color-scheme: light)" srcset="assets/light_image.png">
  <img alt="Image description" src="assets/dark_image_OR_light_image.png"> #Default image if no theme is detected
</picture>