Introduce Jekyll site structure, navigation, and GitHub Pages deploy workflow#7
Open
nduytg wants to merge 2 commits into
Open
Introduce Jekyll site structure, navigation, and GitHub Pages deploy workflow#7nduytg wants to merge 2 commits into
nduytg wants to merge 2 commits into
Conversation
### Motivation - Migrate the repository to a Jekyll-based GitHub Pages site to provide structured collections for cheat sheets, projects, and posts and to simplify publishing. - Provide a consistent site layout and navigation so content can be reorganized into `_docs/`, `_projects/`, and `_posts/` while preserving legacy directories during migration. - Enable automated site builds and deployments to GitHub Pages via Actions and streamline Markdown linting configuration for front-matter support. ### Description - Add a GitHub Actions workflow `/.github/workflows/pages-deploy.yml` to build the site with Jekyll and deploy to GitHub Pages on pushes to `main`. - Introduce Jekyll configuration and site structure files including `_config.yml`, `_layouts/default.html`, `_data/navigation.yml`, and collection pages `index.md`, `cheat-sheets.md`, `projects.md`, `blog.md`, `about.md`, plus example content in `_docs/`, `_posts/`, and `_projects/`. - Update repository metadata and guidance in `README.md` to describe the new Jekyll content model, CI/CD, and Pages domain behavior, and remove the custom `CNAME` file. - Adjust markdown linter settings in `.pymarkdown.json` to enable `front-matter` support and disable rule `md041`, while allowing `br` for `md033`. ### Testing - No automated tests were executed as part of this change. - CI artifacts: a Pages build-and-deploy workflow was added but not run within this rollout.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
/,/cheat-sheets/,/projects/, and/blog/.mainto GitHub Pages.Description
/.github/workflows/pages-deploy.ymlto build the site with Jekyll and deploy pages on pushes tomainand build on pull requests._config.ymlwithcollectionsanddefaults, adding_layouts/default.html, navigation data at_data/navigation.yml, and collection content under_docs/,_posts/, and_projects/.index.md,cheat-sheets.md,projects.md,blog.md,about.md, plus sample content files and a site announcement post in_posts/.README.md, removing the customCNAME, and adjusting Markdown linter settings in.pymarkdown.jsonto enablefront-matterand disablemd041while permittingbrformd033.Testing
pre-commit run --all-fileslocally which executes thepymarkdownchecks and the linting run completed successfully.Codex Task