{"id":15663056,"url":"https://github.com/healeycodes/inkbyexample","last_synced_at":"2025-05-06T02:08:37.089Z","repository":{"id":48631800,"uuid":"291037744","full_name":"healeycodes/inkbyexample","owner":"healeycodes","description":"✒ A hands-on introduction to Ink using annotated example programs.","archived":false,"fork":false,"pushed_at":"2021-07-16T20:14:37.000Z","size":8765,"stargazers_count":19,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-06T02:08:29.836Z","etag":null,"topics":["ink","ink-programming-language","tour","tutorial"],"latest_commit_sha":null,"homepage":"https://inkbyexample.com","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/healeycodes.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}},"created_at":"2020-08-28T12:12:35.000Z","updated_at":"2024-12-26T19:55:44.000Z","dependencies_parsed_at":"2022-08-27T10:11:28.763Z","dependency_job_id":null,"html_url":"https://github.com/healeycodes/inkbyexample","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/healeycodes%2Finkbyexample","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/healeycodes%2Finkbyexample/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/healeycodes%2Finkbyexample/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/healeycodes%2Finkbyexample/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/healeycodes","download_url":"https://codeload.github.com/healeycodes/inkbyexample/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252607037,"owners_count":21775415,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["ink","ink-programming-language","tour","tutorial"],"created_at":"2024-10-03T13:35:21.608Z","updated_at":"2025-05-06T02:08:37.046Z","avatar_url":"https://github.com/healeycodes.png","language":"CSS","readme":"[![CI](https://github.com/healeycodes/inkbyexample/actions/workflows/ink.yml/badge.svg)](https://github.com/healeycodes/inkbyexample/actions/workflows/ink.yml)\n\n# Ink by Example\n\nContent and build toolchain for [Ink by Example](https://inkbyexample.com), a site that teaches [Ink](https://dotink.co/) via annotated example programs.\n\nAll tooling is written in Ink and the programs are evaluated as part of the build process.\n\nSyntax highlighting powered by [September](https://github.com/thesephist/september).\n\n\u003cbr\u003e\n\n[![Image of https://inkbyexample.com](https://github.com/healeycodes/inkbyexample/blob/main/static/preview.png)](https://inkbyexample.com/)\n\n\u003cbr\u003e\n\n## Add an Annotated Program\n\n- Add the title to `examples.ink`\n- Create a matching Ink program in `/examples` that exports `intro`, `rows`, and `end`.\n- A title of `Foo Bar` needs a program named `foo-bar.ink`\n\n```\nintro := 'The introduction precedes the code sections. It should not be left empty.'\n\nrows := [\n    {\n        docs: 'A that function adds two numbers together. This text will appear on the left of the code.'\n        code: 'add := (x, y) =\u003e x + y'\n    },\n    {\n        docs: 'A function multiplies two numbers together.'\n        code: 'multiply := (x, y) =\u003e x * y'\n    }\n]\n\nend := 'The end section is left of the terminal output. It can be left empty.'\n```\n\n\u003cbr\u003e\n\n## Contributing\n\nRaise an issue before starting a PR. **I'm happy to help out!** You can also DM me on Twitter [@healeycodes](https://twitter.com/healeycodes)\n\n\u003cbr\u003e\n\n## Build\n\n`make build-linux` or `make build-mac`\n\nThe website is built to `/public`.\n\n\u003cbr\u003e\n\n## Test\n\n`make test-linux` or `make test-mac`\n\nCheck stdout for runtime errors.\n\n\u003cbr\u003e\n\n## Deploy\n\nThis repository uses Netlify for CI/CD and there's a `netlify.toml` with the configuration required.\n\nOtherwise, serve the `/public` directory.\n\n\u003cbr\u003e\n\n## Thanks to\n\n[@thesephist](https://github.com/thesephist) for creating the Ink programming language, writing the `SPEC.md` and amazing documentation at https://dotink.co/ which served as a jumping off point.\n\nMark McGranaghan for creating the original [Go by Example](https://github.com/mmcgrana/gobyexample) which provided styling and structure for this project.\n\n\u003cbr\u003e\n\n## License\n\nGo by Example is copyright Mark McGranaghan and licensed under a\n[Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).\n\nEverything else is licensed under MIT.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhealeycodes%2Finkbyexample","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhealeycodes%2Finkbyexample","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhealeycodes%2Finkbyexample/lists"}