{"id":19529717,"url":"https://github.com/vala-lang/valadoc-org","last_synced_at":"2026-01-25T07:37:23.157Z","repository":{"id":38312151,"uuid":"69593960","full_name":"vala-lang/valadoc-org","owner":"vala-lang","description":"Build tools used to generate valadoc.org","archived":false,"fork":false,"pushed_at":"2025-06-02T21:21:50.000Z","size":5459,"stargazers_count":83,"open_issues_count":52,"forks_count":25,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-06-03T11:52:22.524Z","etag":null,"topics":["documentation","vala","valadoc","website"],"latest_commit_sha":null,"homepage":"https://valadoc.org","language":"Vala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vala-lang.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}},"created_at":"2016-09-29T18:04:34.000Z","updated_at":"2025-06-02T21:21:54.000Z","dependencies_parsed_at":"2024-03-23T21:24:30.699Z","dependency_job_id":"d9d78bb2-5e0a-4aac-beeb-c7af16f5b7bc","html_url":"https://github.com/vala-lang/valadoc-org","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vala-lang/valadoc-org","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vala-lang%2Fvaladoc-org","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vala-lang%2Fvaladoc-org/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vala-lang%2Fvaladoc-org/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vala-lang%2Fvaladoc-org/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vala-lang","download_url":"https://codeload.github.com/vala-lang/valadoc-org/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vala-lang%2Fvaladoc-org/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28747709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T05:12:38.112Z","status":"ssl_error","status_checked_at":"2026-01-25T05:04:50.338Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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","vala","valadoc","website"],"created_at":"2024-11-11T01:27:07.567Z","updated_at":"2026-01-25T07:37:23.150Z","avatar_url":"https://github.com/vala-lang.png","language":"Vala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Valadoc.org\n\nStays crunchy, even in milk.\n\nThis package contains build-tools used to generate valadoc.org and ideally shouldn't be used to\ngenerate other pages.\n\n\nBuilding\n========\n\nIn order to build the docs you will need the following:\n* `valadoc` \u003e= 0.35.0\n* `php`\n* 4 GB of free space\n\nOn elementary OS or Ubuntu run:\n```bash\nsudo add-apt-repository ppa:vala-team\nsudo apt update\nsudo apt install valac valadoc libvaladoc-dev libjson-glib-dev unzip php php-curl \n```\n\nArch or derivatives run:\n```bash\npacman -S vala php\n```\n\nNext, install JS dependencies:\n```bash\nnpm install\n```\n\nAfter you have `valadoc` installed, you can move to building the documentation. Simply run:\n```bash\nmake serve\n```\n\nThis will take a bit of time, so grab yourself a cup of coffee; if you’re impatient, run:\n\n```bash\nmake serve-mini\n```\n\nfor a minimal test version. If you\nencounter an error at this step, please see the [common pitfalls](#common-pitfalls) section. After\nyou completed building, you should see a `valadoc.org` folder.\n\nTo access the documentation navigate your browser to http://localhost:7777.\n\n\nInstall locally\n===============\n\nTo install valadoc documentation as devhelp books, first build the pages with either\n```bash\nmake build-docs-mini build-data GENERATOR_OPTS=--skip-existing\n```\nfor just glib, gio and gobject, or\n```bash\nmake build-docs build-data GENERATOR_OPTS=--skip-existing\n```\nfor all packages. This can take a bit longer.\n\nAfter that you can run\n```bash\nsudo make install\n```\nto install the devhelp books in your system. Now launch Devhelp and use them!\n\n\nSearching\n=========\n\nFor a more complete experience, you will need to install [manticore](https://manticoresearch.com/install/) and `xsltproc`.\n\nOn elementary OS or Ubuntu run:\n```bash\nsudo apt install xsltproc\n```\n\nThe run the following command to generate search indexes:\n```bash\nmake serve-search\n```\n\nThis will (eventually!) start a manticore daemon on port `51413`.\n\n\nAdd New Packages\n================\n\nOpen `documentation/packages.xml` and add a new package-entry.\n\nUse `\u003cexternal-package\u003e` to create external links:\n\n```xml\n\u003cexternal-package name=\"package-name\" link=\"http://path/to/docs\"\u003e\n  short description\n\u003c/external-package\u003e\n```\n\nUse `\u003cpackage\u003e` to build and include documentation for vapi files:\n\n```xml\n\u003cpackage name=\"gdl-1.0\"\u003e\n  short description\n\u003c/package\u003e\n```\n\nThe following attributes are supported:\n\n| Name              | Description                                        |\n|-------------------|----------------------------------------------------|\n| name              | The vapi name                                      |\n| deprecated        | Set it to '\"true\"' to mark a package as deprecated |\n| maintainers       | List of binding maintainers                        |\n| gir               | The GIR file used to extract documentation from    |\n| c-docs            | Link to C documentation                            |\n| ignore            | Do not build documentation for this entry          |\n| home              | Homepage link                                      |\n| flags             | Additional vala flags (Missing dependencies, ...)  |\n| gallery\t        | Link to a GTK-Doc widget gallery                   |\n| vapi-image-source | Source to download images from                     |\n\n\nReferenced GIR and vapi-files have to be part of one of the following repositories:\n- [vala](http://vala-project.org/)\n- [vala-girs](https://github.com/nemequ/vala-girs)\n- [vala-extra-vapis](https://gitlab.gnome.org/GNOME/vala-extra-vapis)\n\n\nAdd New Source Code Examples\n============================\n\nCopy your examples to `examples/\u003cvapi-name\u003e/` and add a new entry to `examples/\u003cvapi-name\u003e/\u003cvapi-name\u003e.valadoc.examples`:\n\n```xml\n\u003cexample\u003e\n  \u003ctitle\u003eExample Title\u003c/title\u003e\n  \u003cimage\u003eoptional-screenshot.png\u003c/image\u003e\n  \u003cfile\u003efile-name-1.vala\u003c/file\u003e\n  \u003cfile\u003efile-name-2.vala\u003c/file\u003e\n  \u003ccompile\u003evalac file-name1.vala file-name-2.vala ...\u003c/compile\u003e\n  \u003cnode\u003eAssociated.Symbol.name1\u003c/node\u003e\n  \u003cnode\u003eAssociated.Symbol.name2\u003c/node\u003e\n\u003c/example\u003e\n```\n\nIf this is the first example for the package, add a line to the `check-examples` target of `Makefile`.\n\nAdd Handwritten Documentation\n=============================\n\nCreate a new file called `\u003cvapi-name\u003e.valadoc` in `documentation/\u003cvapi-name\u003e/`:\n\n```\n...\n\n/**\n * My valadoc comment\n */\nc::c_symbol_name\n```\n\n```\n...\n\n/**\n * My valadoc comment\n */\nVala.Symbol.Name\n```\n\nTool Overview\n==============\n\n- *generator:* Parses `packages.xml` files describing all packages. It is responsible for building\n  up the page. It fetches resources such as images from specified sources, computes valadoc-calls,\n  builds documentation for specified packages and puts-together the whole page. (`make serve`, `make serve-mini`)\n- *configgen:* Used to generate configuration files for our search index.\n- *valadoc-example-gen:* Internally used to generate example listings.\n- *valadoc-example-tester:* Compiles and checks all registered examples. (`make test-examples`)\n\n\nCommon Pitfalls\n===============\n\n`Uncaught Error: Class 'mysqli' not found`\n- Uncomment `extension=mysqli.so` in your OS's php.ini (`find /etc -name php.ini`)\n\n`error: failed to load driver`\n- Your valadoc version does not support the requested vala version. Install a recent vala version and\n  recompile valadoc.\n- Change `VALAC_VERSION` in Makefile.\n\nOther errors:\n- Check `LOG` in the root of this repo for more information\n- Have you run out of disk space?\n\n\nContact And Help\n=================\n\n- [Homepage](http://www.valadoc.org), [GIT](https://github.com/vala-lang/valadoc-org)\n- [Issue Tracker, valadoc.org](https://github.com/vala-lang/valadoc-org/issues)\n- [Issue Tracker, valadoc (now a part of Vala)](https://gitlab.gnome.org/GNOME/vala/issues)\n- IRC: irc.gnome.org, #vala (flo, UTC+01:00)\n- Mail: flo.brosch@gmail.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvala-lang%2Fvaladoc-org","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvala-lang%2Fvaladoc-org","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvala-lang%2Fvaladoc-org/lists"}