Speaker
Description
In the digital age, effective documentation is essential for a variety of purposes, including teaching, software development, and personal projects. This workshop aims to equip participants with the skills to create and deploy online documentation using Docusaurus and GitHub Pages. This user-friendly solution does not require additional knowledge of programming languages or web design and encourages easy collaboration, though basic familiarity with GitHub and Markdown would be helpful.
Designed for students, software developers, researchers and teachers, this course is specially useful for educators in general. It allows them to create comprehensive course documentation, including lecture notes and hands-on guidelines, in an easily accessible and editable online format using the user-friendly Markdown Extended (MDX) format supported by Docusaurus.
The workshop begins with a short presentation that introduces the complete workflow and explains what is happenig behind the scene in the GitHub. It then includes an interactive hands-on session where participants will build and deploy their documentation projects from scratch, with step-by-step guidance. Participants will start by creating and setting up a GitHub account, then forking a prepared Docusaurus project template. They will familiarise themselves with the available MDX options and make the necessary changes to the documentation. Next, participants will set up static GitHub pages and a CI/CD pipeline. By the end of the session, each participant will have a documentation website that automatically updates and deploys with any project changes, ensuring that documentation is always up to date.
Although we focus on specific tools (Docusaurus and GitHub, for their user-friendliness and plugins support), the skills participants gain in this workshop can be applied to many different others, giving flexibility for future projects.
Requirements: each participant should have a laptop with internet access.
Examples of using a similar setup for online courses:
on GitHub, on GitLab
