{"id":48214347,"url":"https://github.com/wurstscript/wurstscript.github.io","last_synced_at":"2026-04-04T18:55:13.761Z","repository":{"id":24627972,"uuid":"101400930","full_name":"wurstscript/wurstscript.github.io","owner":"wurstscript","description":"WurstScript website and documentation","archived":false,"fork":false,"pushed_at":"2026-03-25T20:41:15.000Z","size":19641,"stargazers_count":8,"open_issues_count":3,"forks_count":16,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-03-26T20:18:35.510Z","etag":null,"topics":["documentation","github-pages","tutorial","wurstscript-website"],"latest_commit_sha":null,"homepage":"https://wurstlang.org/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wurstscript.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-08-25T12:19:12.000Z","updated_at":"2026-03-25T20:41:18.000Z","dependencies_parsed_at":"2024-03-04T13:30:10.152Z","dependency_job_id":"a565e31b-579a-4012-b2f5-3cae1fdad361","html_url":"https://github.com/wurstscript/wurstscript.github.io","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/wurstscript/wurstscript.github.io","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wurstscript%2Fwurstscript.github.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wurstscript%2Fwurstscript.github.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wurstscript%2Fwurstscript.github.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wurstscript%2Fwurstscript.github.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wurstscript","download_url":"https://codeload.github.com/wurstscript/wurstscript.github.io/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wurstscript%2Fwurstscript.github.io/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31409470,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T10:20:44.708Z","status":"ssl_error","status_checked_at":"2026-04-04T10:20:06.846Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","github-pages","tutorial","wurstscript-website"],"created_at":"2026-04-04T18:55:13.145Z","updated_at":"2026-04-04T18:55:13.748Z","avatar_url":"https://github.com/wurstscript.png","language":"HTML","readme":"[![pages-build-deployment](https://github.com/wurstscript/wurstscript.github.io/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/wurstscript/wurstscript.github.io/actions/workflows/pages/pages-build-deployment)\n# WurstScript Webpage \u0026 Documentation\n\nLive at https://wurstlang.org/\n\nThis folder contains the complete source of the WurstScript website, configured as jekyll project and deployed via github-pages.\n\n# Developer Information\n\n## Serving the page locally:\n\n1. Check whether you have Ruby 3.2+ installed:\n\n    `ruby --version`\n\n    This project currently uses Bundler 4.x (see `Gemfile.lock`), which requires Ruby \u003e= 3.2.\n\n2. Install Bundler:\n\n    `gem install bundler`\n\n3. Execute\n\n    `bundler install`\n\n\n4. Run the server with:\n\n    `bundler exec jekyll serve`\n\n## Styling\n\nWe use Sass as stylesheet language and you can find the files inside the `_sass` folder.\n\n## Tutorials\n\nTutorials are included as part of the documentation in their own section.\n\nTo create a new tutorial:\n\n* Create a new markdown file in the `_tutorials/` folder, for example `cp saveload.md new_tutorial.md`.\n* Adjust the frontmatter such as title, excerpt, date\n* The tutorial will be automatically added to the documentation page, the sidebar is generated from markdown headings\n\n## Standard library doc\n\nAdding a standard library doc page works almost the same as tutorials.\n\n* Create a new table of contents file in `_doc/stdlib/`\n* Create a new set of tuturial pages in a subfolder of `_doc/stdlib/`, e.g. `_doc/stdlib/new_doc`\n* Define the pages by changing the contents of `_doc/stdlib/new_doc/`\n* __This part differs__ Add the new doc page to the stdlib index in `_doc/stdlib/intro.md`. Entries should be alphabetically sorted.\n* Setup `new_doc.md` as necessary for your pages:\n    - Edit the title, excerpt, date, color.\n    - Change the `sections` to match the uri of the pages of your tutorial.\n* Write your new_doc pages, being sure to update the heading sections as necessary.\n\n## Building Search Index\n\nThe site now uses `pagefind` for fully local static search. No external API key is required.\n\nFor GitHub Pages compatibility, the generated `pagefind/` folder is committed to this repository.\n\n1. Build the site:\n\n    `bundler exec jekyll build`\n\n2. Generate the search index into `_site/pagefind`:\n\n    `npx -y pagefind --site _site`\n\n3. Sync the generated index into tracked `pagefind/`:\n\n    `rm -rf pagefind \u0026\u0026 cp -R _site/pagefind ./pagefind`\n\n   PowerShell equivalent:\n\n    `if (Test-Path pagefind) { Remove-Item -Recurse -Force pagefind }; Copy-Item -Recurse _site/pagefind ./pagefind`\n\n4. Serve `_site` (or deploy it). Search will load from `/pagefind/pagefind.js`.\n\nPrerequisite for indexing: Node.js (for `npx pagefind`).\n\n### Pre-commit Hook For Indexing\n\nSet up repo hooks once:\n\n`git config core.hooksPath .githooks`\n\nThen every commit will:\n\n1. Build Jekyll\n2. Generate Pagefind index\n3. Sync `_site/pagefind` to tracked `pagefind/`\n4. Auto-stage `pagefind/`\n\nTo bypass once:\n\n`SKIP_PAGEFIND_HOOK=1 git commit ...`\n\nPowerShell equivalent:\n\n`$env:SKIP_PAGEFIND_HOOK='1'; git commit ...; Remove-Item Env:SKIP_PAGEFIND_HOOK`\n\n### Jenkins\n\nThis repo now includes a root-level `Jenkinsfile` that automatically:\n\n1. Installs Ruby gems (`bundler install`)\n2. Builds the site (`bundler exec jekyll build`)\n3. Generates Pagefind index (`npx -y pagefind --site _site`)\n4. Archives `_site/**` as build artifacts\n\nTo use it:\n\n1. Create a Jenkins Pipeline (or Multibranch Pipeline) job for this repository.\n2. Keep script source as `Jenkinsfile` in SCM.\n3. Ensure the Jenkins agent has Ruby/Bundler and Node.js/npm available.\n\n### Local dev with `jekyll serve`\n\n`jekyll serve` rebuilds `_site`. To keep local search working:\n\n1. Start Jekyll:\n\n    `bundler exec jekyll serve`\n\n2. In a second terminal, generate Pagefind index:\n\n    `npx -y pagefind --site _site`\n\n3. Repeat step 2 after content changes that should be searchable.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwurstscript%2Fwurstscript.github.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwurstscript%2Fwurstscript.github.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwurstscript%2Fwurstscript.github.io/lists"}