|
1 | | -# UIC Tech Solutions Open Source Fund Website |
| 1 | +# Equalify PDF Converter - Documentation |
2 | 2 |
|
3 | | -This repository contains the source code for the UIC Tech Solutions Open Source Fund (OSF) website. The website serves to inform visitors about the fund, aggregate open micro-grants from supported projects, and solicit partnerships. |
| 3 | +Documentation site for the [Equalify PDF Converter](https://github.com/EqualifyEverything/equalify-pdf-converter), which transforms PDF course materials into accessible, semantic markup for the University of Illinois Chicago. |
4 | 4 |
|
5 | | -**Live Site:** [https://uic-osf.github.io/website/](https://uic-osf.github.io/website/) |
| 5 | +Forked from the [UIC OSF website](https://github.com/UIC-OSF/website) to maintain consistent UIC branding (header/footer). |
6 | 6 |
|
7 | | -## 🚀 Overview |
| 7 | +## Tech Stack |
8 | 8 |
|
9 | | -The UIC OSF website is a modern, responsive React application designed to highlight the fund's mission: supporting technology projects that work toward measurable public benefit. |
| 9 | +- **Framework:** React + Vite |
| 10 | +- **Language:** TypeScript |
| 11 | +- **Styling:** Tailwind CSS |
| 12 | +- **Markdown:** react-markdown + remark-gfm + rehype-highlight |
| 13 | +- **Routing:** React Router (HashRouter) |
| 14 | +- **Deployment:** GitHub Pages via GitHub Actions |
10 | 15 |
|
11 | | -**Key Features:** |
12 | | -* **Dynamic Micro-Grant Aggregation:** Fetches and displays open issues tagged with "micro-grant" from GitHub repositories (AI Leaders, Equalify). |
13 | | -* **Project Showcase:** Highlights supported Open Source projects. |
14 | | -* **Team Section:** Introduces key team members. |
15 | | -* **Partnership Solicitation:** Encourages organizations to partner with the fund. |
16 | | -* **Accessibility:** Built with accessibility in mind, using semantic HTML and high-contrast colors. |
| 16 | +## Getting Started |
17 | 17 |
|
18 | | -## 🛠️ Tech Stack |
19 | | - |
20 | | -* **Framework:** [React](https://react.dev/) + [Vite](https://vitejs.dev/) |
21 | | -* **Language:** [TypeScript](https://www.typescriptlang.org/) |
22 | | -* **Styling:** [Tailwind CSS](https://tailwindcss.com/) |
23 | | -* **Icons:** [Lucide React](https://lucide.dev/) |
24 | | -* **Animations:** [Framer Motion](https://www.framer.com/motion/) |
25 | | -* **Deployment:** [GitHub Pages](https://pages.github.com/) |
26 | | - |
27 | | -## 💻 Getting Started |
28 | | - |
29 | | -Follow these steps to run the project locally on your machine. |
30 | | - |
31 | | -### Prerequisites |
32 | | - |
33 | | -* Node.js (v18 or higher recommended) |
34 | | -* npm (comes with Node.js) |
| 18 | +```bash |
| 19 | +npm install |
| 20 | +npm run dev |
| 21 | +``` |
35 | 22 |
|
36 | | -### Installation |
| 23 | +Opens at `http://localhost:5173/equalify-pdf-converter-docs/` |
37 | 24 |
|
38 | | -1. **Clone the repository:** |
39 | | - ```bash |
40 | | - git clone https://github.com/UIC-OSF/website.git |
41 | | - cd website |
42 | | - ``` |
| 25 | +## Building |
43 | 26 |
|
44 | | -2. **Install dependencies:** |
45 | | - ```bash |
46 | | - npm install |
47 | | - ``` |
| 27 | +```bash |
| 28 | +npm run build # outputs to dist/ |
| 29 | +npm run preview # preview the production build |
| 30 | +``` |
48 | 31 |
|
49 | | -3. **Run the development server:** |
50 | | - ```bash |
51 | | - npm run dev |
52 | | - ``` |
53 | | - The app should now be running at `http://localhost:5173` (or similar). |
| 32 | +## Adding Documentation |
54 | 33 |
|
55 | | -## 📦 Building and Deploying |
| 34 | +1. Add a markdown file to `src/content/` |
| 35 | +2. Add an entry to `src/docs-nav.ts` with the title, path, and filename |
| 36 | +3. The file will automatically be available as a routed page |
56 | 37 |
|
57 | | -### Build for Production |
| 38 | +## Keeping Header/Footer in Sync with OSF Site |
58 | 39 |
|
59 | | -To create a production-ready build: |
| 40 | +`src/components/Layout.tsx` contains the UIC header and footer, kept identical to the [OSF website](https://github.com/UIC-OSF/website). The upstream remote tracks the original repo: |
60 | 41 |
|
61 | 42 | ```bash |
62 | | -npm run build |
| 43 | +git fetch upstream |
| 44 | +git diff upstream/main -- src/components/Layout.tsx |
63 | 45 | ``` |
64 | 46 |
|
65 | | -This will generate a `dist` folder containing the compiled assets. |
66 | | - |
67 | | -### Deploy to GitHub Pages |
68 | | - |
69 | | -This project is configured to deploy to GitHub Pages automatically via GitHub Actions whenever changes are pushed to the `main` branch. |
70 | | - |
71 | | -The deployment workflow is defined in `.github/workflows/deploy.yml`. |
| 47 | +## Deployment |
72 | 48 |
|
| 49 | +Pushes to `main` automatically deploy to GitHub Pages via `.github/workflows/deploy.yml`. |
73 | 50 |
|
74 | | -## 📂 Project Structure |
| 51 | +## Project Structure |
75 | 52 |
|
76 | 53 | ``` |
77 | | -uic-osf/ |
78 | | -├── public/ # Static assets |
79 | | -├── src/ |
80 | | -│ ├── components/ # Reusable UI components (Hero, MicroGrants, etc.) |
81 | | -│ ├── App.tsx # Main application component |
82 | | -│ ├── main.tsx # Entry point |
83 | | -│ └── index.css # Global styles and Tailwind directives |
84 | | -├── index.html # HTML template |
85 | | -├── package.json # Project dependencies and scripts |
86 | | -├── tailwind.config.js # Tailwind CSS configuration |
87 | | -├── vite.config.ts # Vite configuration |
88 | | -└── README.md # Project documentation |
| 54 | +src/ |
| 55 | + components/ |
| 56 | + Layout.tsx # UIC header + footer (synced with OSF site) |
| 57 | + DocsLayout.tsx # Docs page layout (sidebar + content) |
| 58 | + DocsSidebar.tsx # Left navigation sidebar |
| 59 | + MarkdownPage.tsx # Markdown renderer component |
| 60 | + content/ # Markdown documentation files |
| 61 | + pages/ |
| 62 | + Home.tsx # Landing page |
| 63 | + docs-nav.ts # Sidebar navigation structure |
| 64 | + index.css # Tailwind + highlight.js styles |
| 65 | + main.tsx # Entry point with HashRouter |
| 66 | + App.tsx # Route definitions |
89 | 67 | ``` |
90 | | -
|
91 | | -## 🤝 Contributing |
92 | | -
|
93 | | -1. Fork the repository. |
94 | | -2. Create a new branch (`git checkout -b feature/YourFeature`). |
95 | | -3. Commit your changes (`git commit -m 'Add some feature'`). |
96 | | -4. Push to the branch (`git push origin feature/YourFeature`). |
97 | | -5. Open a Pull Request. |
98 | | -
|
99 | | -## 📝 Content Guidelines |
100 | | -
|
101 | | -**IMPORTANT:** "Open Source" is religion. It must ALWAYS be capitalized as "Open Source" (capital O, capital S, no hyphen). This rule applies to all content, documentation, and source code comments. |
102 | | -
|
103 | | -## 📄 License |
104 | | -
|
105 | | -[MIT License](LICENSE) (or appropriate license if defined) |
0 commit comments