https://github.com/healeycodes/inkbyexample
✒ A hands-on introduction to Ink using annotated example programs.
https://github.com/healeycodes/inkbyexample
ink ink-programming-language tour tutorial
Last synced: 5 months ago
JSON representation
✒ A hands-on introduction to Ink using annotated example programs.
- Host: GitHub
- URL: https://github.com/healeycodes/inkbyexample
- Owner: healeycodes
- License: mit
- Created: 2020-08-28T12:12:35.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-16T20:14:37.000Z (about 4 years ago)
- Last Synced: 2025-05-06T02:08:29.836Z (5 months ago)
- Topics: ink, ink-programming-language, tour, tutorial
- Language: CSS
- Homepage: https://inkbyexample.com
- Size: 8.36 MB
- Stars: 19
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/healeycodes/inkbyexample/actions/workflows/ink.yml)
# Ink by Example
Content and build toolchain for [Ink by Example](https://inkbyexample.com), a site that teaches [Ink](https://dotink.co/) via annotated example programs.
All tooling is written in Ink and the programs are evaluated as part of the build process.
Syntax highlighting powered by [September](https://github.com/thesephist/september).
[](https://inkbyexample.com/)
## Add an Annotated Program
- Add the title to `examples.ink`
- Create a matching Ink program in `/examples` that exports `intro`, `rows`, and `end`.
- A title of `Foo Bar` needs a program named `foo-bar.ink`
```
intro := 'The introduction precedes the code sections. It should not be left empty.'
rows := [
{
docs: 'A that function adds two numbers together. This text will appear on the left of the code.'
code: 'add := (x, y) => x + y'
},
{
docs: 'A function multiplies two numbers together.'
code: 'multiply := (x, y) => x * y'
}
]
end := 'The end section is left of the terminal output. It can be left empty.'
```
## Contributing
Raise an issue before starting a PR. **I'm happy to help out!** You can also DM me on Twitter [@healeycodes](https://twitter.com/healeycodes)
## Build
`make build-linux` or `make build-mac`
The website is built to `/public`.
## Test
`make test-linux` or `make test-mac`
Check stdout for runtime errors.
## Deploy
This repository uses Netlify for CI/CD and there's a `netlify.toml` with the configuration required.
Otherwise, serve the `/public` directory.
## Thanks to
[@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.
Mark McGranaghan for creating the original [Go by Example](https://github.com/mmcgrana/gobyexample) which provided styling and structure for this project.
## License
Go by Example is copyright Mark McGranaghan and licensed under a
[Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).
Everything else is licensed under MIT.