diff --git a/.gitignore b/.gitignore index e9d39ff175..3d3471e152 100644 --- a/.gitignore +++ b/.gitignore @@ -57,6 +57,8 @@ mlruns/ .link-cache.json .claude/ catalog.json +site/course/ +site/materials.js # Generated by site/build.js on every Vercel deploy (buildCommand) — never # commit, so they can't drift or drop URLs. Regenerated fresh from PHASES. diff --git a/site/README.md b/site/README.md new file mode 100644 index 0000000000..43d3dd80cf --- /dev/null +++ b/site/README.md @@ -0,0 +1,20 @@ +# Run the course website locally + +The website is static and has no package dependencies. From the repository root: + +```sh +node site/build.js +python -m http.server 4173 --directory site +``` + +Open . Use `python3` instead of `python` on systems where that is the Python command. + +The build generates `site/data.js`, `site/materials.js`, and `site/course/`. The last two are ignored by Git because they are rebuilt from the course files already in this repository. Serve the site over HTTP instead of opening `index.html` directly so lesson and quiz files can be loaded by the browser. + +Progress, reading position, theme, and reading preferences are stored only in the current browser with `localStorage`. No account or backend is required. + +Run the progress tracker check with: + +```sh +node site/tests/progress.test.js +``` diff --git a/site/about.html b/site/about.html index 53f76485b5..88e52ad837 100644 --- a/site/about.html +++ b/site/about.html @@ -5,7 +5,7 @@ About - AI Engineering from Scratch - + @@ -109,6 +109,11 @@
About

About this project

+ +

AI Engineering from Scratch is a free, open-source curriculum that builds every core AI algorithm by hand. 503 lessons across 20 phases, from linear algebra to autonomous agents, in Python, TypeScript, Rust, and Julia.

Why it exists

@@ -120,7 +125,7 @@

How it is made

The site itself is deliberately plain: hand-written HTML, CSS, and vanilla JavaScript, no framework. A single build script (site/build.js) reads the lesson Markdown in the repository and generates the catalog, search index, sitemap, and llms.txt on every deploy, so the published numbers can never drift from the source. It is hosted on Vercel.

Who builds it

-

Maintained by Rohit Ghumare and contributors. It is MIT-licensed and free forever. There is no token, no course upsell, and no gated content.

+

The curriculum and website are maintained by Rohit Ghumare and contributors. The project is MIT-licensed and free forever.

Get involved