This code uses Markdoc as a backbone to render the One Fact Foundation website, alongside the rest of our web properties.
GitHub Pages does not support some features of Next.js
as this library is maintained and aligned with Vercel whose business model depends on differentiating features from GitHub Pages.
One example is incremental static regeneration, which is critical to some of our web properties at the One Fact Foundation.
You can use this GitHub Action to deploy the website using only GitHub technology: https://github.com/onefact/onefact.org/blob/main/.github/workflows/nextjs.yml
If you cannot afford Vercel and need any help deploying to GitHub Pages please email us at [email protected] and we will do our best to help :)
Contributions and feedback are welcomed and encouraged. Feel free to open PRs or issues here to fix typos or suggest changes, or reach our team at [[email protected]](mailto:[email protected]].
-
Install the dependencies by running
npm install
-
Start the development server on http://localhost:3000 by running
npm run dev
-
Try editing
pages/index.md
Test locally using npm run dev
.
Use act to test GitHub Actions deployment locally.
Fork this repo, go to settings > pages > source. In the dropdown, select Github Actions.