Overview

The document provides instructions for setting up and configuring a course website using Node.js. It includes details on installing the required software, configuring the course details, theming the website, and organizing lesson files.

Features

• Node.js Development Environment: Set up Node.js v14+ to run the dev server.
• Configuration File: Use the course.json file to configure site details such as author name, company, title, subtitle, and social media handles.
• Theming: Customize the appearance of the website using the styles/variables.css file.
• Image Management: Store images in the public/images folder and easily reference them in markdown files.
• Favicon Customization: Replace the favicon files with your own images or remove them entirely.
• Lesson Organization: Organize lesson files in the lessons/ folder using a specific naming convention.

Installation

To install and set up the course website, follow these steps:

1. Set up Node.js v14+ on your machine.
2. Clone the repository.
3. Run npm install to install dependencies.
4. Run npm run dev to start the dev server.
5. Open http://localhost:3000 in a browser to access the website.
6. Customize the course details in the course.json file.
7. Theme the website by modifying the styles/variables.css file.
8. Place images in the public/images folder and reference them in markdown files.
9. Customize the favicon by replacing the files in the public/images directory.
10. Organize lesson files in the lessons/ folder according to the specified naming convention.

Summary

The document provides instructions for setting up and configuring a course website using Node.js. It includes details on installing the required software, configuring the course details, theming the website, and organizing lesson files. By following the provided instructions, users can easily create and customize their course websites.