Skip to content

README.md

Latest commit

 

History

History
111 lines (80 loc) · 2.22 KB

README.md

File metadata and controls

111 lines (80 loc) · 2.22 KB

FINKI Hub / Recordings Listing

A VitePress-powered website that aggregates links to lecture and exercise recordings for courses at FCSE. Each course has its own Markdown page and is available via the sidebar for quick navigation.

Note: All rights to the recordings belong to their respective owners. Links are shared for educational purposes only.

Features

  • Course pages with structured links to recordings (by week/topic)
  • Sidebar navigation to browse all courses
  • Simple contribution flow via pull requests

Prerequisites

  • Node.js 20+ (LTS recommended)

Setup

Clone the repository and install dependencies:

git clone https://github.com/finki-hub/recordings-listing.git
cd recordings-listing
npm install

Scripts

Dev server (local preview with HMR):

npm run docs:dev

The terminal will display a local URL to open in your browser.

Build the static site:

npm run docs:build

The output is generated in .vitepress/dist.

Preview the production build locally:

npm run docs:preview

Linting

Lint all Markdown files:

npm run lint:md

Auto-fix what can be fixed:

npm run lint:md:fix

Rules are configured in .markdownlint.jsonc. Build output and cache folders are ignored via .markdownlintignore.

Project Structure

.
├─ .vitepress/
│  └─ config.ts
├─ courses/
│  ├─ index.md
│  ├─ structural-programming.md
│  └─ ...
└─ index.md

Adding a New Course Page

  1. Create a new Markdown file in courses/, for example:
    • courses/structucal-programming.md
  2. Add content: short intro + structured list of recordings and resources.
  3. Add the page to the sidebar in .vitepress/config.ts so it appears in the UI:
// .vitepress/config.ts
export default defineConfig({
  // ...
  themeConfig: {
    // ...
    sidebar: [
      {
        text: "Преглед",
        items: [
          { text: "Предмети", link: "/courses/" },
          {
            text: "Структурно програмирање",
            link: "/courses/structural-programming",
          }, // New page
        ],
      },
    ],
  },
});

License

This project is licensed under the terms of the MIT license.