Это код генератора статического сайта для Neurodata.io.
Как минимум, вам потребуются следующие установленные инструменты:
Если у вас нет Grow, вы можете установить его, используя:
curl https://install.grow.io | bash
или (из виртуальной среды)
pip install grow
Обратите внимание, что Grow пока не поддерживает Python 3.
Перед запуском сервера разработки вам, возможно, придется установить зависимости, используемые вашим проектом. Команда grow install
проведет вас через все это и попытается настроить вашу среду под вас.
Команда grow run
запускает ваш сервер разработки. Вы можете вносить изменения в файлы проекта и обновлять их, чтобы немедленно увидеть их отражение.
grow install
grow run
Вы можете использовать команду grow build
для сборки всего сайта в каталоге build
. Это хороший способ протестировать и проверить сгенерированный код.
grow build
Отправьте запросы на включение для deploy
ветки.
Существует файл LaTeX, который преобразует ссылки в PDF, в основном для контроля качества. Он расположен в корневом каталоге и может быть собран путем запуска make
в корневом каталоге.
При добавлении нового дополнения в файлы нагрудников будут работать большинство обычных записей нагрудников, единственным дополнительным шагом будет добавление значения keywords
. Ниже показано, какие ключевые слова следует использовать для каждого файла нагрудников, поскольку они используются для организации файла. Общие правила:
author+an
. Это позволит подчеркнуть членов лаборатории и выделить имя Джово жирным шрифтом в разделах публикации его резюме. Глядя на порядок авторов в стартовой записи, укажите, какие авторы являются членами лаборатории ( trainee
), а какие — jovo ( highlight
). Например: @article{example,
author = {<lab member> and <not lab member> and <jovo> and <lab member> and <not lab member>},
author+an = {1=trainee;4=trainee;3=highlight},
...
@incollection
, если вы не добавляете нового участника в файл people.bib
.month
является целым числом, поскольку это предотвращает потенциальные проблемы с заказом.&
и $
, так как они могут вызвать проблемы с составлением нагрудника.Категории для pubs.bib:
peer-reviewed
in-review
conference
book
tech
abspos
other
omit
категории для talks.bib:
local
international
Категории для press.bib:
Вся информация о членах команды как на странице сайта Neurodata.io/about/team/, так и в резюме Джово (neurodata.io/about/jovo, раздел «Наставничество») получена из файла bib, расположенного в content/bibs/people.bib
. Очень важно, чтобы каждый обновлял свою личную информацию, поскольку это будет отражено в резюме Джово. Помимо добавленной здесь информации, вам необходимо будет загрузить изображение в content/source/images/people
и указать его имя в категории file
(например, john_doe.jpg
). См. ниже, если вы хотите добавить на веб-сайт кого-то, кто не должен отображаться ни в резюме, ни на странице Teams.
@incollection{<ID>,
author = {Full name},
usera = {Job title},
month = {Month, as an integer, that you started working},
year = {starting year},
number = {starting month/year -- ending month/year},
series = {ending year},
abstract = {What you do in the lab, 1-2 sentences, 3rd person},
userb = {highest degree held},
userc = {department/major, school},
userd = {website category},
keywords = {cv category},
doi = {github username},
note = {email address},
url = {personal website (do not include https://)},
usere = {training},
file = {image name}
}
Некоторые категории можно оставить пустыми, если они неприменимы. Категории, в которых должна содержаться информация: <ID>
, author
, usera
, month
, year
, number
и userd
. Еще несколько примечаний:
Для userb
и userc
настоятельно рекомендуется использовать сокращения.
year
и series
должны содержать все 4 цифры года (т.е. 2019, а не 19).
number
должен быть в формате {01/18 -- }
если участник команды все еще является членом лаборатории, и {01/18 -- 04/21}
если он больше не является участником.
Категории для userd
(в порядке размещения на странице команд):
faculty
faculty - research
staff
postdoc
student
undergrad
associate
highschool
Категории для keywords
:
researchtrackfaculty
staffresearch
postdoc
PhDstudent
visitingdoc
MSstudent
undergrad
HS
Ваше изображение можно найти здесь (), если вы уже находитесь на сайте.
Текущие поддерживаемые записи usere
:
safe-zone
Пример записи:
@incollection{johndoe,
author = {John Doe},
usera = {Research Assistant},
month = {7},
year = {2019},
number = {7/19 -- },
series = {},
abstract = {Lead developer on <project>, helping with <something>...},
userb = {BSE},
userc = {BME, JHU},
userd = {student},
keywords = {MS},
doi = {jnydoe},
note = {[email protected]},
url = {www.heresjohnny.com},
usere = {safe-zone},
file = {john_doe.jpg}
}
Для этого просто скопируйте запись ниже (да, в разделах number
и series
должны быть пробелы) и измените соответствующую информацию. other
спецификация как для userd
, так и keywords
предписывает веб-сайту игнорировать показ этих людей на странице Teams (хотя они будут появляться при ссылке в другом месте), а резюме игнорировать их при создании.
@incollection{johndoe,
author = {John Doe},
usera = {},
month = {},
year = {},
number = { },
series = { },
abstract = {},
userb = {},
userc = {},
userd = {other},
keywords = {other},
doi = {},
note = {[email protected]},
url = {},
usere = {},
file = {john_doe.jpg}
}
В НАСТОЯЩЕЕ ВРЕМЯ РАЗРАБОТКА
Вы можете скомпилировать PDF-файл локально, запустив команду pdflatex
для файла jovo_cv_SOM.tex
в папке content/bibs/tex/
. Если вы внесли какие-либо изменения в файлы bib, вам также нужно будет запустить команду biber
для файла jovo_cv_SOM
:
biber jovo_cv_SOM
pdflatex jovo_cv_SOM.tex