Imported from Xiaotian-Liu-MKT/Xiaotian-Liu-MKT.github.io (
AGENTS.md). Install upstream withnpx skills add Xiaotian-Liu-MKT/Xiaotian-Liu-MKT.github.io. Copyright stays with the author.
Repository Guidelines
Project Structure & Module Organization
_config.ymlholds site-wide configuration and author/profile settings._pages/,_posts/,_portfolio/,_publications/,_talks/,_teaching/are content collections (Markdown with front matter)._includes/and_layouts/contain reusable partials and page templates._sass/andassets/hold styles and compiled front-end assets (notablyassets/js/).images/andfiles/store static media and downloadable artifacts.markdown_generator/,talkmap/, andscripts/contain helper notebooks/scripts.
Build, Test, and Development Commands
bundle installinstalls Ruby/Jekyll dependencies fromGemfile.bundle exec jekyll serve -l -H localhostruns the site athttp://localhost:4000with live reload.jekyll serve -l -H localhostis a shorter alternative when the global Jekyll environment is already set up.docker compose upruns the site using the providedDockerfileanddocker-compose.yaml.npm installinstalls JS dependencies for asset bundling.npm run build:jsminifies JS intoassets/js/main.min.js.npm run watch:jswatchesassets/js/**and rebuilds on change.
Coding Style & Naming Conventions
- Use 2-space indentation in YAML, HTML, SCSS, and Markdown front matter; avoid tabs.
- Keep Markdown content in collections with standard Jekyll front matter (
---blocks). - Posts follow
YYYY-MM-DD-title.mdin_posts/(example:2015-08-14-blog-post-4.md). - Page filenames in
_pages/should be short and descriptive (e.g.,about.md,cv.md). - No formatter or linter is enforced; keep edits consistent with surrounding files.
Testing Guidelines
- No automated test suite is defined.
- Validate changes by running the local server and spot-checking affected pages and navigation.
Commit & Pull Request Guidelines
- Recent history uses short, imperative messages like
Update _config.yml; keep commit subjects concise and specific. - PRs should include a clear summary, list of changed pages/sections, and local verification steps.
- Include screenshots or GIFs for layout or styling changes.
- Link related issues when applicable.
Configuration & Content Tips
- Treat
_config.ymlas the source of truth for site metadata; changes here affect many pages. - Add PDFs and other assets to
files/so they are served at/files/...URLs.
