From ce54967c420c7fe240b945559fe3c29b518c8c07 Mon Sep 17 00:00:00 2001 From: Sina Atalay Date: Wed, 29 May 2024 15:57:27 +0300 Subject: [PATCH] docs: answer an FAQ in the developer guide --- docs/developer_guide.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/developer_guide.md b/docs/developer_guide.md index f845219..2cba7f2 100644 --- a/docs/developer_guide.md +++ b/docs/developer_guide.md @@ -95,4 +95,9 @@ Whenever the `testdata` folder is generated, the files should be reviewed manual ### How can I add a new social network to RenderCV? -To be answered. +To add a new social network to RenderCV, go to the `rendercv/data_models.py` file and follow these steps: + +1. Append the social network name (for example, "Facebook") to the `SocialNetworkName` type. +2. If necessary, implement its username validation in the `SocialNetwork.check_username` method. +3. Implement its URL generation using the `SocialNetwork.url` method. If the URL can be generated by appending the username to a hostname, only update `url_dictionary`. +4. Finally, include the $\LaTeX$ icon of the social network to the `icon_dictionary` in the `CurriculumVitae.connections` method. RenderCV uses the [`fontawesome5`](https://ctan.org/pkg/fontawesome5?lang=en) package. The available icons can be seen [here](https://fosszone.csd.auth.gr/CTAN/fonts/fontawesome5/doc/fontawesome5.pdf).