В цьому репозиторії знаходиться шаблон для виконання курсової роботи.
Для виконання курсової роботи необхідно зробити fork
цього репозіторію, склонувати вже власний репозіторій та розміщувати документацію у відповідних діректоріях ./docs
.
В цьому файлі необхідно вказати назву проекту. Коротку загальну характеристику проекту, контактні дані виконавця, посилання на репо співвиконавців(за необхідністю).
Шаблон публікування курсової роботи підготовлено з використанням VuePress, та теми vuepress-theme-hope/vuepress-theme-hope.
Щоб опублікувати проект у Github Pages:
-
у вже склоновануму репозиторію на локальному компьютері ви переходите в
./docs/.vuepress/config.ts
, в цьому файлі змінюєте на свої данні за інструкцією. -
робите коміт у вітку main(master) та пушите його на віддалений репозиторій github, автоматично спрацьовує workflow та починається процес деплою
-
на сторінці github вашого репозиторію переходите в
Settings
-->Pages
, вSourse
обираєте варіантDeploy from branch
, вBranch
обираєтеgh-pages
та папку/root
та натискаєтеSave
та повертаєтесь до головної сторінки репозиторію. -
Почекайте поки на боковій панелі зʼявиться
Deployments
та в ньомуgithub-pages
(може зайняти і більше хвилинни) та переходите по ньому, там ви побачите url до сторінки вашої документації.
Для відлагодження документації в локальному режимі запускаємо
npm run docs:dev
Доступ до локально опублікованої версії http://localhost:8080
Happy learning! Happy coding!