Metadata-Version: 2.4
Name: mkdocs-curriculum-vitae
Version: 0.12.0
Summary: MkDocs Theme for curriculum vitae
Author-email: Paul Riviere <paolo3799@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Paul-Riviere
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://paul-riviere.github.io/mkdocs-curriculum-vitae/
Project-URL: Issues, https://github.com/Paul-Riviere/mkdocs-curriculum-vitae/issues
Project-URL: Source, https://github.com/Paul-Riviere/mkdocs-curriculum-vitae
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Operating System :: POSIX
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Software Development :: Build Tools
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.5.3
Provides-Extra: lint
Requires-Dist: djlint==1.34.0; extra == "lint"
Requires-Dist: yamllint==1.32.0; extra == "lint"
Requires-Dist: shot-scraper==1.8; extra == "lint"
Dynamic: license-file

# mkdocs-curriculum-vitae

[![documentation](https://img.shields.io/badge/docs-mkdocs--curriculum--vitae-blue.svg?style=flat)](https://paul-riviere.github.io/mkdocs-curriculum-vitae/)
[![pypi](https://img.shields.io/pypi/v/mkdocs-curriculum-vitae.svg)](https://pypi.org/project/mkdocs-curriculum-vitae/)
[![downloads](https://img.shields.io/pypi/dm/mkdocs-curriculum-vitae.svg)](https://pypi.org/project/mkdocs-curriculum-vitae/)
[![license](https://img.shields.io/pypi/l/mkdocs-curriculum-vitae.svg)](https://pypi.python.org/pypi/mkdocs-curriculum-vitae)
[![gitpod-ready-to-code](https://img.shields.io/badge/gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/Paul-Riviere/mkdocs-curriculum-vitae)

## Description

A MkDocs theme, made to build your own curriculum vitae.

This theme generates a single page, for now you cannot put other md files than the index. There isn't any navbar.

Currently you cannot configure grid layout, or colors. This will be implemented soon.

## Demo

You can see a [live exmple here](https://paul-riviere.github.io/mkdocs-curriculum-vitae-example/) and see how it is configured on [the demo project](https://github.com/Paul-Riviere/mkdocs-curriculum-vitae-example).

Here's an example with basic configuration :

![](docs/assets/themes/default.png)

## Usage

See [documentation](https://paul-riviere.github.io/mkdocs-curriculum-vitae/how-to-use-it/).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) file.

## Credits

Thanks a lot to the amazing [NES.css](https://github.com/nostalgic-css/NES.css) project, that I used to create the nes theme. The css was adapted to this repo, and the icons were rebuilt with Piskel because the originals weren't compliant with the current html/css. Those icons helped me designing the other ones, such as X, Gitlab, and Tiktok.
