Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Deploy to GitHub Pages

on:
push:
branches: [master]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout your repository using git
uses: actions/checkout@v7
- name: Install, build, and upload your site
uses: withastro/action@v6

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5
60 changes: 34 additions & 26 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,33 +1,41 @@
# Jekyll
# build output
dist/

# generated types
.astro/

# dependencies
node_modules/

# build caches
*.tsbuildinfo

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# environment variables
.env
.env.production

# macOS-specific files
.DS_Store

# jetbrains setting folder
.idea/

# VS Code
.vscode/

# Jekyll (legacy)
_site/
.jekyll-cache
.jekyll-metadata
.sass-cache

# Ruby
.bundle/
.byebug_history
.ruby-gemset
.ruby-version
.ruby-gemset
*.gem
Gemfile.lock

# Files
.analysis
.DS_Store
*.swp
*~

# Folders
/vendor
bbin/
bin/
coverage
gh-pages/
pkg/
test/dest
tmp/*
scraps/

# IDE droppings
.idea/
Gemfile.lock
2 changes: 0 additions & 2 deletions Gemfile

This file was deleted.

32 changes: 23 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,29 @@
# Jython Website
This is the source repository for the Jython website.

This is the source repository for the Jython website, built with [Astro](https://astro.build).

## To develop the website

A quick guide to developing the website locally
A quick guide to developing the website locally:

1. Clone this repository.
2. Install [Bun](https://bun.sh), then install the dependencies:
`bun install`
3. Run `bun run dev` and browse to the printed URL (usually http://localhost:4321).
4. Make changes to the source in `src/`; the page will hot-reload.
5. Run `bun run build` to produce a static site in `dist/`.
6. Once you're happy with the changes create a pull request.

## Project structure

- `src/pages/*.md` — Markdown content pages (one file per page).
- `src/layouts/BaseLayout.astro` — the page layout (header, navigation, footer).
- `src/components/Navbar.astro` — the navigation bar.
- `src/data/navbar.ts` — the navigation bar entries.
- `public/` — static files copied as-is into the build (`CNAME`, `.well-known/`, assets, stylesheet).
- `assets/` (top level) — the original source images, now mirrored under `public/assets/`.

1. Clone this repository
2. Run `bundle exec jekyll serve` in the repository. See [here](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll) for more information on setting up Jekyll
3. Browse to [http://127.0.0.1:4000](http://127.0.0.1:4000)
4. View the website locally
5. Make changes to the source
6. Refresh the browser page and the changes should be visible
7. Once you're happy with the changes create a pull request
## Deployment

The site is published to GitHub Pages from `master` by the workflow in
`.github/workflows/deploy.yml`, which builds with Bun and uploads `dist/`.
5 changes: 0 additions & 5 deletions _config.yml

This file was deleted.

16 changes: 0 additions & 16 deletions _data/book.yml

This file was deleted.

47 changes: 0 additions & 47 deletions _data/navbar.yml

This file was deleted.

4 changes: 0 additions & 4 deletions _data/pydoc.yml

This file was deleted.

94 changes: 0 additions & 94 deletions _includes/navigation.html

This file was deleted.

59 changes: 0 additions & 59 deletions _layouts/default.html

This file was deleted.

16 changes: 0 additions & 16 deletions assets/css/style.scss

This file was deleted.

Loading