jsoncv
1.0.0
Инструментарий для создания вашего резюме с помощью JSON и создания стильных файлов HTML/PDF.
JSONCV состоит из следующих компонентов:
Для подробных объяснений и руководящих принципов использования, пожалуйста, обратитесь к документации ниже.
JSONCV Используйте схему JSON для создания стандарта на основе JSON для CVS.
Схема, используемая в JSONCV, представляет собой вилку схемы резюме JSON со следующими различиями:
Json схема версия
JSON RESUME использует устаревшую версию Draft-04, в то время как JSONCV использует текущий DRACK-07. Чтобы обеспечить совместимость с Draft-07, все экземпляры additionalItems были удалены.
Дополнительная секция sideProjects
JSONCV включает в себя дополнительный раздел, называемый sideProjects , который позволяет проводить различие между побочными проектами и карьерными проектами
Дополнительное name свойство в meta Section
JSONCV включает в себя свойство name в разделе meta , которое позволяет пользователю указать желаемое имя для экспортированных файлов HTML/PDF.
Эти различия не влияют на совместимость между JSONCV и JSON RESUME. Это означает, что вы можете легко импортировать данные о резюме JSON в JSONCV и наоборот, поскольку данные JSONCV будут передавать проверку схемы резюме JSON.
Полная разница между схемой резюме JSON и схемой JSONCV можно посмотреть здесь
JSONCV поставляется с онлайн -редактором, который предоставляет графический пользовательский интерфейс для создания и редактирования ваших данных JSONCV. Посетите его по адресу https://jsoncv.reorx.com/editor/.
Редактор состоит из трех панелей, слева направо:
Боковая панель
Позволяет навигации в разные разделы в форме схемы и предоставляет такие операции, как «Загрузить HTML» и «Загрузка данных»
Форма схемы
Позволяет вам редактировать свойства данных вашего резюме. Вы также можете выбрать, какие свойства отображать или скрыть.
Предварительный просмотр
Отображает отображаемый CV HTML, поскольку изменения вносятся в форме схемы.
Основным продуктом JSONCV является CV HTML, который представляет собой HTML -представление ваших данных JSONCV. Это компактный, однолетный HTML-документ, который может быть преобразован в PDF или размещен в Интернете для создания статического веб-сайта CV.
CV HTML разработан с определенной макетой для отображения резюме на листе A4 бумаги. CSS была адаптирована для оптимизации печати, обеспечивающей лучшую типографию, напечатанную на бумаге или сохранена в качестве PDF. Таким образом, CV HTML лучше всего подходит для создания профессиональных или академических резюме CVS/Resum, а не для творческих или интерактивных портфельных сайтов.
CV HTML поддерживает темы, которые можно найти в каталоге src/themes .
Чтобы получить CV HTML, обратитесь к данным экспорта CV и HTML и создайте HTML на локальном уровне
Конвертеры - это сценарии, чтобы помочь пользователю преобразовать данные JSONCV из/в другие источники.
В настоящее время доступен только один конвертер: rxresume-to-jsoncv.js , который преобразует данные, экспортируемые из Rxresume в формат JSONCV.
Если у вас есть какие -либо дополнительные требования, пожалуйста, не стесняйтесь отправить проблему. Запросы на вытягивание также высоко ценятся.
Рекомендуется написать ваше резюме с помощью онлайн -редактора. Однако, если вам удобно с JSON, вы можете сохранить файл данных, используя текстовый редактор на вашей локальной машине.
Когда вы открываете редактор в первый раз, загружается образец данных. Вы можете либо отредактировать его, либо нажать кнопку «Новые данные», чтобы начать с пустой формы. Ваши данные резюме сохраняются в вашем браузере каждый раз, когда вы вносите изменения, поэтому вам не нужно беспокоиться о потере работы.
Если у вас уже есть локальная копия ваших данных CV, вы можете нажать кнопку «Загрузить данные», чтобы загрузить их в редактор.
После того, как вы закончите редактирование, вы можете нажать кнопку загрузки JSON , чтобы экспортировать данные CV в формате JSON.
Если вы хотите экспортировать рендерированный HTML на панели предварительного просмотра, просто нажмите кнопку «Скачать HTML» .
Обратите внимание, что вы можете назвать экспортируемые файлы, добавив свойство meta.name . Если это не указано, имя файла будет построено с использованием комбинации basics.name и meta.version .
Чтобы все было просто, JSONCV не включает и не использует какие -либо внешние инструменты для генерации PDF. Вместо этого вы должны использовать сгенерированный HTML -файл для преобразования его в PDF -документ. Единственное требование - современный браузер; Приведенные ниже шаги используют Google Chrome в качестве примера:
Откройте сгенерированный HTML -файл в Chrome.
Нажмите ⌘ P (или ⌃ P в Windows), и откроется диалог печати.
В диалоговом окне выберите «Пункт назначения» как «Сохранить как PDF» и убедитесь, что все элементы в «параметрах» не проверены.
Нажмите «Сохранить», чтобы сохранить файл PDF в вашей файловой системе.
Обратите внимание, что PDF, экспортированный из Chrome, могут иметь некоторые проблемы с копированием текста. Для получения дополнительной информации см. Раздел FAQ.
JSONCV использует VITE в качестве инструмента для строительства статического сайта. Файл index.html в корне проекта является точкой входа для заработной платы HTML с одним файлом.
Вот шаги по созданию CV HTML с использованием ваших собственных данных:
Убедитесь, что вы используете Nodejs версию 18 или выше.
Установите зависимости, работая: npm run install
Создайте свой CV HTML, указав переменные среды DATA_FILENAME и OUT_DIR :
DATA_FILENAME="$HOME/Downloads/mycv/cv.json" OUT_DIR="$HOME/Downloads/mycv" npm run build
Это построит ваш CV HTML, используя файл данных, расположенный по адресу $HOME/Downloads/mycv/cv.json , и сгенерированный HTML будет расположен в каталоге $HOME/Downloads/mycv .
Следующие переменные среды поддерживаются в процессе сборки:
DATA_FILENAME : данные CV для использования могут быть относительным или абсолютным путем.OUT_DIR : выходной каталог для сгенерированного файла HTML.THEME : тема для использования, должна быть одно из имени каталога в src/themes/ .Чтобы настроить основной цвет темы, измените переменную CSS-Primary CSS в index.scss. Обратите внимание, что внесение этого изменения приведет к неустановленным изменениям в GIT. Если вы хотите создать HTML самостоятельно, рекомендуется создать новый проект вместо редактирования исходного кода в JSONCV. Для инструкций о том, как это сделать, пожалуйста, обратитесь к разделу «Построить статический сайт».
Сгенерированный файл index.html может использоваться в любом месте и на любой платформе хостинга. Просто загрузите его на веб -сервер, и у вас будет свой собственный онлайн -сайт CV. Встроенная тема «Reorx» также включает в себя адаптивную поддержку мобильных устройств.
Однако, если вам нужна дополнительная настройка, например, сайт CV по адресу https://cv.reorx.com/, который имеет нижний колонтитул со ссылками на файл PDF и домашнюю страницу автора, вы можете выполнить эти шаги:
Создать пустой репозиторий
Добавить JSONCV в качестве подмодуля
git submodule add https://github.com/reorx/jsoncv.git
Поместите свой файл данных CV, например, cv.json , в проект.
Инициализировать package.json с помощью npm init .
Установите JSONCV как зависимость, используя npm i ./jsoncv .
Скопируйте scripts и devDependencies от ./jsoncv/package.json , чтобы package.json , а затем запустите npm i , чтобы установить их.
Copy ./jsoncv/vite.json.js для vite.json.js и внесите следующие изменения:
./src на ./jsoncv/src .dataFilename на ваш файл данных CV, например, cv.json .renderData.theme на тему, которую вы хотите использовать. Копировать ./jsoncv/index.html на index.html и изменить все экземпляры ./src на ./jsoncv/src . Затем копируйте ./jsoncv/index.scss в index.scss .
npm run build , чтобы проверить, если все работает.
После завершения этих шагов вы можете добавить свои собственные элементы и стили в index.html и index.scss для дальнейшей настройки веб -сайта CV. Вы можете использовать HTML, CSS и JavaScript, чтобы добавить свой собственный брендинг, макет и функциональность на сайт.
JSONCV включает в себя несколько встроенных тем, которые вы можете использовать либо непосредственно в редакторе, либо при создании статического CV-сайта. Если вы хотите создать свою собственную тему, вот как:
Иерархия файловой системы для тем следующая:
src/themes
└── reorx
├── index.ejs
└── index.scss
Вы можете добавить свою собственную тему, создав новую папку в src/themes с помощью файлов index.ejs и index.scss .
index.ejs - это шаблон EJS, используемый для построения CV -содержания. Данные, передаваемые в шаблон, структурированы следующим образом:
cv : Все данные JSONCV, соответствующие схеме JSONCVfn : набор функций утилитыgetCVTitle : получает заголовок CV из данных cvreformatDate : преобразует строку даты в указанный форматgetIconSVG : получает значок строки SVG или элемент DOM от имени значкаnoSchemaURL : удалить схему ( https:// ) префикс URLДля получения дополнительной информации см. Полное определение в src/themes/data.js.
После того, как вы создали новую тему (в качестве примера давайте используем yourtheme ), вы можете начать разработку и предварительно просмотреть ее, запустив следующий код:
THEME=yourtheme npm run dev-site
Получите запросы на добавление новых тем, всегда приветствуются.
Вы можете просто назвать тему после вашего собственного имени, это то, что я сделал для темы «Reorx». Потому что я думаю, что эта тема тесно связана с эстетическим и личным вкусом разработчика, и общие слова могут не точно представлять эту тему.
Да, это известная проблема с функцией Chrome «Сохранить как PDF». Полученные PDF -файлы могут иметь текст, который стоит обратно при копировании в Preview.App на macOS.
Об этой проблеме сообщили несколько пользователей и не специфичны для JSONCV. Как видно из: «Сохранить как PDF», создает документы с обратным текстом. - Google Chrome Community
Решение: используйте Firefox или Safari, чтобы получить PDF
Смотрите ли заказ объекта гарантии JavaScript? - Stack Overflow
summary и свойствах description JSONCV не может быть возможным без этих удивительных проектов ниже:
Если вы думаете, что этот проект приятен в использовании, или экономит некоторое время, подумайте о том, чтобы дать мне чашку кофе :)
