From 7e2610c0e91c532d4cffb09872e78ccb82551a96 Mon Sep 17 00:00:00 2001 From: Germain LEFEBVRE Date: Wed, 12 Feb 2025 14:38:43 +0100 Subject: [PATCH] docs: Improve documentation --- docs/mkdocs.yml | 1 + docs/readthedocs/format/html.md | 10 ++++---- docs/readthedocs/format/pdf.md | 6 ++++- docs/readthedocs/getting-started/cv.yml | 6 +++++ .../getting-started/generate-cv.md | 8 +++++++ docs/readthedocs/getting-started/write-cv.md | 24 +++++++++++++++++++ docs/readthedocs/themes/library.md | 21 ++++++++++++++++ docs/readthedocs/themes/publish-theme.md | 1 - 8 files changed, 71 insertions(+), 6 deletions(-) create mode 100644 docs/readthedocs/themes/library.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 9be5c8b..41f7770 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -60,6 +60,7 @@ nav: - Install a remote theme: themes/install-theme.md - Write your theme: themes/write-theme.md - Publish your theme: themes/publish-theme.md + - Library: themes/library.md - Contributing: - How to contribute: - Issues: contributing/issues.md diff --git a/docs/readthedocs/format/html.md b/docs/readthedocs/format/html.md index 5f21abe..90f3e05 100644 --- a/docs/readthedocs/format/html.md +++ b/docs/readthedocs/format/html.md @@ -1,15 +1,17 @@ # HTML format -## Getting started - -!!! info "Default format" +!!! info "Default format is HTML" The default format for the generated CV is HTML. +## Getting started + You can generate a HTML version of your CV by adding the flag `--format=html` to the `cvwonder` command. ```bash cvwonder generate --input=cv.yml --output=generated/ --format=pdf ``` -As the HTML format is the default format, you can omit the `--format=html` flag. +??? note "Flag is optional" + + As the HTML format is the default format, you can omit the `--format=html` flag. diff --git a/docs/readthedocs/format/pdf.md b/docs/readthedocs/format/pdf.md index d128491..12c5b40 100644 --- a/docs/readthedocs/format/pdf.md +++ b/docs/readthedocs/format/pdf.md @@ -1,5 +1,9 @@ # PDF format +!!! info "Default format is HTML" + + The default format for the generated CV is [HTML](html.md). + ## Getting started You can generate a PDF version of your CV by adding the flag `--format=pdf` to the `cvwonder` command. @@ -12,4 +16,4 @@ cvwonder generate --input=cv.yml --output=generated/ --format=pdf The PDF format is generated using the `rod` Go package. The package is a high-level API for the Chrome DevTools Protocol. Formerly it opens a headless browser, load the HTML file, and save the PDF file. -To generate the PDF, `cvwonder` generates the HTML file then generates the PDF file. +To generate the PDF, `cvwonder` generates the HTML file then the PDF file. diff --git a/docs/readthedocs/getting-started/cv.yml b/docs/readthedocs/getting-started/cv.yml index 2336ba8..059a2be 100644 --- a/docs/readthedocs/getting-started/cv.yml +++ b/docs/readthedocs/getting-started/cv.yml @@ -80,6 +80,12 @@ certifications: link: https://www.credly.com/badges/dd09dc40-9ef8-43a4-addb-d861d4dadf26/public_url badge: images/aws-certified-solutions-architect-associate.png +languages: + - name: Francais + level: Maternelle + - name: Anglais + level: Aisance professionnelle + education: - schoolName: IG2I - Centrale schoolLogo: images/centrale-lille-logo.webp diff --git a/docs/readthedocs/getting-started/generate-cv.md b/docs/readthedocs/getting-started/generate-cv.md index 76f869b..a35097c 100644 --- a/docs/readthedocs/getting-started/generate-cv.md +++ b/docs/readthedocs/getting-started/generate-cv.md @@ -26,6 +26,14 @@ You can automatically regenerate your CV when updating either the YAML file or t cvwonder generate --input=cv.yml --output=generated/ --watch ``` +??? info "Only on supported themes" + + The watch feature is available on themes that have included the `livereload.js` script. + + ```html + + ``` + ## Serve the generated CV You can render and serve your CV on a simple HTTP server which will automatically refresh the page when updating either the YAML file or the theme. diff --git a/docs/readthedocs/getting-started/write-cv.md b/docs/readthedocs/getting-started/write-cv.md index 494678d..4d34d68 100644 --- a/docs/readthedocs/getting-started/write-cv.md +++ b/docs/readthedocs/getting-started/write-cv.md @@ -275,6 +275,30 @@ The certifications section is used to describe the certifications you have. badge: images/aws-certified-solutions-architect-associate.png ``` +### Languages + +The languages section is used to describe the languages you speak. + +| Field | Description | +| --- | --- | +| Name | The name of the language. | +| Level | The level of the language. | + +??? example "Example" + + Add your languages in the languages section: + + ```yaml + languages: + - name: French + level: Native + - name: English + level: Fluent + ``` + +!!! abstract "Level" + The `Level` field is a text field. It represents your level of the language in the way that you want to show. + ### Education The education section is used to describe your school and education. diff --git a/docs/readthedocs/themes/library.md b/docs/readthedocs/themes/library.md new file mode 100644 index 0000000..8095da5 --- /dev/null +++ b/docs/readthedocs/themes/library.md @@ -0,0 +1,21 @@ +--- +hide: + - toc +--- +# Themes library + +Here is a non-exhaustive list of themes available for CVWonder. + +| Theme | Description | Author | Link | +|-------|-------------|--------|------| +| Default | A default theme for CVWonder | [Germain LEFEBVRE](https://github.com/germainlefebvre4) | [cvwonder-theme-default](https://github.com/germainlefebvre4/cvwonder-theme-default) | +| Basic | A basic theme for CVWonder | [Germain LEFEBVRE](https://github.com/germainlefebvre4) | [cvwonder-theme-basic](https://github.com/germainlefebvre4/cvwonder-theme-basic) | + +Share your theme with the community by following the [Publish theme](publish-theme.md) section. + +## Discover more themes + +Look for CVWonder themes on Github based on the Search and Topics. + +* [Keyword](https://github.com/search?q=cvwonder-theme-&type=repositories){:target="_blank"}: `cvwonder-theme-` +* [Topic](https://github.com/topics/cvwonder-theme){:target="_blank"}: `cvwonder-theme` diff --git a/docs/readthedocs/themes/publish-theme.md b/docs/readthedocs/themes/publish-theme.md index 4df4b9d..16306c4 100644 --- a/docs/readthedocs/themes/publish-theme.md +++ b/docs/readthedocs/themes/publish-theme.md @@ -72,4 +72,3 @@ git push origin main This will probably change in the future. If you want to use another hosting platform, please open an issue on the [Github repository](https://github.com/germainlefebvre4/cvwonder/issues). -