{"id":18318988,"url":"https://github.com/emojicode/emojicode.github.io","last_synced_at":"2026-02-26T16:02:44.013Z","repository":{"id":3286634,"uuid":"48755932","full_name":"emojicode/emojicode.github.io","owner":"emojicode","description":"The Emojicode Documentation ","archived":false,"fork":false,"pushed_at":"2023-10-16T02:43:50.000Z","size":7419,"stargazers_count":79,"open_issues_count":10,"forks_count":42,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-14T07:11:47.811Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://www.emojicode.org","language":"Mustache","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emojicode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2015-12-29T16:17:32.000Z","updated_at":"2023-12-14T18:27:54.000Z","dependencies_parsed_at":"2024-11-05T18:12:15.449Z","dependency_job_id":null,"html_url":"https://github.com/emojicode/emojicode.github.io","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/emojicode%2Femojicode.github.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emojicode%2Femojicode.github.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emojicode%2Femojicode.github.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emojicode%2Femojicode.github.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emojicode","download_url":"https://codeload.github.com/emojicode/emojicode.github.io/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248054196,"owners_count":21039952,"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":[],"created_at":"2024-11-05T18:12:11.022Z","updated_at":"2026-02-26T16:02:38.980Z","avatar_url":"https://github.com/emojicode.png","language":"Mustache","funding_links":[],"categories":["Mustache"],"sub_categories":[],"readme":"# Emojicode Documentation\n\nThis is the official documentation for [Emojicode](http://emojicode.org).\n\n## Building the documentation\n\nThe documentation is built from Markdown and JSON source files by a compiler\nwritten in JavaScript. A Node.js installation is required to run it.\n\nYou can install its dependencies with npm:\n\n```sh\nyarn\n```\n\nIf you want to work on the documentation you can use\n\n```sh\n./serve\n```\n\nwhich starts a web server on port 8080 and automatically rebuilds the\ndocumentation when changes are made.\n\n## Source Structure\n\nThe important source files that live in the `src` directory are:\n\n- The files in `references` and `guides` which are compiled to *books*. Each\n  file represents one chapter and each book has a `chapters.json` listing these\n  chapters.\n\n- `packages` contains resource to compile the package pages and APIs.\n\n  Each package has its own directory containing a `meta.json` and a\n  `package.json` file. The `package.json` file represents the package API can be\n  generated by the Emojicode compiler using the `-r` option.\n\n  All packages that shall be included in the documentation are listed in\n  `packages/packages.json`.\n\n## Emojicode Documentation Syntax\n\nIn addition to GFM, Emojicode Documentation supports syntax for callouts and\ngrammar.\n\n### Callouts\n\nTo create a *Hint* callout begin all lines with `\u003e!H`. Likewise, *Caution*\nnotices are indicated by `\u003e!N`.\n\nExample:\n\n```\n\u003e!H This chapter only introduces the three most important classes although there are many more.\n\u003e!H\n\u003e!H You can browse the whole API of the s package here.\n```\n\n### Grammar\n\nA grammar rule is define like this:\n\n```\n$defined-rule$-\u003e $rule$\n```\n\nAll rule names must always be enclosed in `$` signs, while the rule being\ndefined is closed with `$-\u003e` instead of just a `$`.\n\nThe documentation compiler parses all rules, adds hyperlinks and warns of\nundefined or unreachable rules.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femojicode%2Femojicode.github.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femojicode%2Femojicode.github.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femojicode%2Femojicode.github.io/lists"}