{"id":13556299,"url":"https://github.com/TriplyDB/Documentation","last_synced_at":"2025-04-03T09:31:09.097Z","repository":{"id":37470701,"uuid":"193116328","full_name":"TriplyDB/Documentation","owner":"TriplyDB","description":"Documentation for the TriplyDB and TriplyETL products","archived":false,"fork":false,"pushed_at":"2024-09-16T08:33:26.000Z","size":12469,"stargazers_count":6,"open_issues_count":5,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-09-17T10:28:31.701Z","etag":null,"topics":["etl-framework","etl-pipeline","graph-database","linked-data","production-systems","semantic-web"],"latest_commit_sha":null,"homepage":"https://docs.triply.cc","language":"HTML","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/TriplyDB.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":"authors.yml","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-21T14:57:24.000Z","updated_at":"2024-09-16T08:32:45.000Z","dependencies_parsed_at":"2024-03-14T12:30:46.344Z","dependency_job_id":"c026d0eb-7e3b-4648-87f4-f585f1d68944","html_url":"https://github.com/TriplyDB/Documentation","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/TriplyDB%2FDocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TriplyDB%2FDocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TriplyDB%2FDocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TriplyDB%2FDocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TriplyDB","download_url":"https://codeload.github.com/TriplyDB/Documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246976199,"owners_count":20863035,"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":["etl-framework","etl-pipeline","graph-database","linked-data","production-systems","semantic-web"],"created_at":"2024-08-01T12:03:44.893Z","updated_at":"2025-04-03T09:31:07.037Z","avatar_url":"https://github.com/TriplyDB.png","language":"HTML","funding_links":[],"categories":["Others","others"],"sub_categories":[],"readme":"# Documentation for TriplyDB\n\nThis repository contains the TriplyDB documentation files. These files are used by the Triply documentation website over at \u003chttps://docs.triply.cc/\u003e.\n\n## Covered products\n\nThis repository includes documentation for the following Triply products:\n\n\u003cdl\u003e\n  \u003cdt\u003eTriplyDB\u003c/dt\u003e\n  \u003cdd\u003eAn integrated linked data environment for publishing and using linked data knowledge graphs.\u003c/dd\u003e\n  \u003cdt\u003eTriplyETL\u003c/dt\u003e\n  \u003cdd\u003eA library that is optimized for building production-grade linked data pipelines.\u003c/dd\u003e\n  \u003cdt\u003eTriplyDB.js\u003c/dt\u003e\n  \u003cdd\u003eA library for automating tasks in TriplyDB instances and for building applications that tap into a linked data knowledge graph.\u003c/dd\u003e\n\u003c/dl\u003e\n\n## Contributing\n\n- Feel free to open issues with questions about the documentation.\n- Feel free to create pull requests with adjustments or additions that you believe to be valuable.\n\n## Available markdown\n\nYou are able to use [GitHub Flavored Markdown](https://github.github.com/gfm/). As well as the following extensions\n\n**Custom ID headers**:\nBy default ID's will be created from the content of a header, allowing deep linking to them using the #hash part of a URL.\n```md\n## My Header\n```\n\nThis will result in link `http://docs.triply.cc/path-to-file/#my-header`.\n\nUsing the following syntax you are able to assign custom id's to headers if you do not want the default ID:\n\n```md\n## My Header {: #my-custom-header-id}\n```\nThis will result in link `http://docs.triply.cc/path-to-file/#my-custom-header-id`.\n\n## Guideline for authors\n- Always start your page with a heading of level 1 (1 hashsign)\n- Subheadings of level 2 (2 hashsigns) will appear as submenu on that page\n- Level 1 links in the menu that only contain subpage will not be clickable until a developer creates a mapping in `docs/js/triply.js`\n\n## Installation\n\nThis website uses [MkDocs](https://www.mkdocs.org/) to convert Markdown to HTML so the documentation can be viewed in a web browser. Follow the instructions on their website to install MkDocs.\n\nRequired plugins:\n- To render `mermaid` you will need to install [this plugin](https://github.com/fralau/mkdocs-mermaid2-plugin).\n\nThe following steps often work/suffice:\n1. Install Python and Pip.\n2. Run `pip install mkdocs`\n3. Run `pip install mkdocs-mermaid2-plugin`\n4. Run `pip install mkdocs-redirects`\n\n## Building and running the Documentation website\n\nAfter you have successfully installed MkDocs, you can run a local web server with the following command (run from the root of this repository):\n\n```sh\nmkdocs serve --strict\n```\n\nTo build a static HTML website for deployment, run this command:\n\n```sh\nmkdocs build\n```\nThis will generate the required HTML and CSS in a folder `./site`.\n\n\nTo publish this website, push your changes to the master branch. The live documentation site should be updated shortly after that. If there are any errors, you can find more details in [the GitHub Actions](https://github.com/TriplyDB/Documentation/actions).\n\n### Notes about syntax highlighting\nThis project uses [highlightjs.org](https://highlightjs.org) for rendering code blocks with syntax highlighting. This projects does not have support for Turtle/SPARQL by default. We use a custom build to provide syntax highlighting for these.\n\n```sh\nmkdir Highlight.js\ncd Highlight.js\ngit clone https://github.com/highlightjs/highlight.js.git\ngit clone https://github.com/mightymax/highlightjs-turtle.git\ncd highlight.js/src/languages\nln -s ../../../highlightjs-turtle/src/sparql.js\nln -s ../../../highlightjs-turtle/src/turtle.js\ncd ../../\nnode tools/build.js turtle sparql typescript javascript\ncp build/highlight.min.js \u003cpath-to-this-repo\u003e/js\ncp build/demo/styles/intellij-light.css \u003cpath-to-this-repo\u003e/css\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTriplyDB%2FDocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTriplyDB%2FDocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTriplyDB%2FDocumentation/lists"}