- Notifications
You must be signed in to change notification settings - Fork4
Blog for the Jupyter Book subproject
jupyter-book/blog
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A blog for the Jupyter Book subproject.
This blog is a smallMyST site along with ajavascript plugin for blogging.
To run it locally, take these steps:
Install NPM and MyST byfollowing the MyST installation instructions.
Install the plugin requirements with NPM:
$ npm install
Build the site:
$ myst start
Theposts/releases/ folder contains automatically generated release posts for all repositories in the Jupyter Book organization.
- Make the release on GitHub
- Re-build the blog
The blog action will catch the latest release and include it in the list, sorted by dates.
The release posts are generated automatically using thesrc/generate_release_notes.py script, which:
- Fetches all repositories from the
jupyter-bookGitHub organization - Retrieves all releases from each repository using the GitHub API
- Sorts releases by date (newest first)
- Generates numbered markdown files with proper frontmatter
- Formats @mentions with backticks for better readability
- Adds formatted dates to titles (e.g., "July 6th, 2025")
Files are named with a numbered prefix to ensure proper ordering until we make it possible to list blog posts sorted by date:
001-{repo-name}-{release-title}.md(newest release)002-{repo-name}-{release-title}.md- ...
224-{repo-name}-{release-title}.md(oldest release)
To generate the release posts locally:
$ python src/generate_release_notes.py
Requirements:
- GitHub CLI (
gh) must be installed and authenticated - Python 3 for processing JSON data
The release posts are automatically generated during the CI/CD build process (see.github/workflows/deploy.yml). This ensures that new releases are always included in the blog without manual intervention.
About
Blog for the Jupyter Book subproject
Resources
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.
Contributors10
Uh oh!
There was an error while loading.Please reload this page.