https://github.com/aygp-dr/athenaeum
Personal knowledge management system built with GitHub Pages and Jekyll
https://github.com/aygp-dr/athenaeum
documentation github-pages jekyll tutorial
Last synced: 5 months ago
JSON representation
Personal knowledge management system built with GitHub Pages and Jekyll
- Host: GitHub
- URL: https://github.com/aygp-dr/athenaeum
- Owner: aygp-dr
- License: mit
- Created: 2025-03-27T09:56:15.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-10-01T22:20:44.000Z (9 months ago)
- Last Synced: 2025-10-14T23:19:41.123Z (8 months ago)
- Topics: documentation, github-pages, jekyll, tutorial
- Language: Makefile
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
<\!--
<<< Author notes: Course header >>>
Include a 1280×640 image, course title in sentence case, and a concise description in emphasis.
In your repository settings: enable template repository, add your 1280×640 social image, auto delete head branches.
Add your open source license, GitHub uses MIT license.
-->
# GitHub Pages
_Create a site or blog from your GitHub repositories with GitHub Pages._
<\!--
<<< Author notes: Step 1 >>>
Choose 3-5 steps for your course.
The first step is always the hardest, so pick something easy\!
Link to docs.github.com for further explanations.
Encourage users to open new tabs for steps\!
-->
## Step 1: Enable GitHub Pages
_Welcome to GitHub Pages and Jekyll :tada:\!_
The first step is to enable GitHub Pages on this [repository](https://docs.github.com/en/get-started/quickstart/github-glossary#repository). When you enable GitHub Pages on a repository, GitHub takes the content that's on the main branch and publishes a website based on its contents.
### :keyboard: Activity: Enable GitHub Pages
1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab.
1. Under your repository name, click **Settings**.
1. Click **Pages** in the **Code and automation** section.
1. Ensure "Deploy from a branch" is selected from the **Source** drop-down menu, and then select `main` from the **Branch** drop-down menu.
1. Click the **Save** button.
1. Wait about _one minute_ then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.
> Turning on GitHub Pages creates a deployment of your repository. GitHub Actions may take up to a minute to respond while waiting for the deployment. Future steps will be about 20 seconds; this step is slower.
> **Note**: In the **Pages** of **Settings**, the **Visit site** button will appear at the top. Click the button to see your GitHub Pages site.
## Development Commands
This project includes a Makefile with helpful commands:
- `make help` - Show all available commands
- `make setup` - Install dependencies for local development
- `make serve` - Serve the site locally with live reload
- `make build` - Build the site for production
- `make clean` - Clean build artifacts
- `make deploy` - Prepare for GitHub Pages deployment
- `make status` - Check deployment status
- `make docs` - Show documentation commands
## Quick Start
```bash
# Setup development environment
make setup
# Start local development server
make serve
```
For detailed documentation, see [CLAUDE.org](./CLAUDE.org).
<\!--
<<< Author notes: Footer >>>
Add a link to get support, GitHub status page, code of conduct, license link.
-->
---
Get help: [Post in our discussion board](https://github.com/orgs/skills/discussions/categories/github-pages) • [Review the GitHub status page](https://www.githubstatus.com/)
© 2023 GitHub • [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) • [MIT License](https://gh.io/mit)