markdown-cv/README.md

30 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2023-03-05 14:00:07 +00:00
# Markdown CV
Create your CV using Markdown with a simple and beautiful theme.
## Usage
1. Go to [`md-cv.sofiaritz.com`](https://md-cv.sofiaritz.com/).
2. Use the given textarea to create your CV, it is automatically saved on `localStorage`.
3. Press the `Imprimir` button to print the CV.
### Advanced usage
You can host the CV on your own server and share a link to the `Markdown CV` instance to have things like links, share
options, etc.
In order to do that you need to do the following:
1. Upload the CV's markdown file to your own server.
2. Ensure the server sends a valid `Access-Control-Allow-Origin`. (for example, `Access-Control-Allow-Origin: *`)
3. Send a link with the following structure: `https://md-cv.sofiaritz.com/?source={full_link}`
(for example, `https://md-cv.sofiaritz.com/?source=https://example.org/cv.md`)
## To-Do
- [ ] Improve the CV-fetching code
- [ ] Prevent flashing when remote CVs are loaded fast
## Expectations
This project was done in just a day. Code quality isn't the best. I will slowly improve the project according to my
needs. The things in the _To-Do_ list will probably be done at some point in time.
However, with that being said, if you'd like to contribute or fix something or suggest anything, feel free to create
an account and go for it! :)