Public site for Emory NLP, built with Astro and deployed to GitHub Pages from main.
- Production URL: https://emorynlp.github.io/ (default for this repo name).
- Custom domain: To serve https://emorynlp.org, configure GitHub Pages to use that domain under Repository → Settings → Pages → Custom domain, then commit a
CNAMEfile at the repository root containingemorynlp.org(or rely on GitHub only—follow GitHub’s prompt). Align the canonicalsiteinastro.config.mjswith the domain you advertise (see comment in that file).
Requires Node.js 22+ (see package.json engines).
npm install
npm run devBuild a static preview of the site:
npm run build
npm run previewContent is Markdown with YAML frontmatter, typed via src/content.config.ts.
| Section | Folder | Notes |
|---|---|---|
| People | src/content/people/ |
current: true keeps someone in the Current list. |
| Papers | src/content/papers/ |
Authors, venue, year, optional links. Optional topics object (researchField?, applicationDomain, task) on Dispatch lists. Served at /papers/. |
| Theses & diss. | src/content/theses/ |
degree and defense date are required in the schema. Optional topics for Dispatch (inferred from title/abstract when omitted). |
| The NLP Dispatch | src/content/dispatch/ |
Triannual magazine issues (/dispatch/ redirects to the latest issue; /dispatch/issues/{slug}/ for each issue). Curates publication and thesis slugs plus editorial fields (column, spotlight, reading list, distinctions, activity news). Optional featured: true on one item per section (papers, activityNews, distinctions, theses) spotlights it at the top of that section. |
| Seminars | src/content/seminars/ |
term drives grouping on the seminars index page. |
| News | src/content/news/ |
featured: true prioritizes the home carousel; optional coverImage: /news/your.webp (images under public/news/). |
Filenames identify the URL slug (jinho-choi.md → /people/jinho-choi/).
- Full logo for the header:
public/emorynlp-logo.png. - Tab / home-screen icons generated from that file:
favicon.ico,favicon-32x32.png, andapple-touch-icon.pnginpublic/. If you replace the logo, overwrite the PNG and regenerate those three files (resize to 16/32/48 px for the ICO, 32 px PNG, and 180 px for Apple touch) so tabs and bookmarks stay crisp.
- Push to
main; the workflow in.github/workflows/deploy-pages.ymlbuilds and uploadsdist/to Pages. - In the repository settings, under Pages → Build and deployment → Source, choose GitHub Actions (not “Deploy from a branch”).
- The first deployment may prompt you to create the
github-pagesdeployment environment—approve once if required.
Branches other than main do not auto-deploy unless you extend the workflow.
Adapt content and attribution as appropriate for lab members and collaborators.