{"id":42511464,"url":"https://github.com/fluree/developers-site","last_synced_at":"2026-01-28T14:12:53.768Z","repository":{"id":37798116,"uuid":"422709918","full_name":"fluree/developers-site","owner":"fluree","description":"Repo containing the docusaurus developers site for the fluree org","archived":false,"fork":false,"pushed_at":"2025-12-18T23:15:26.000Z","size":84023,"stargazers_count":5,"open_issues_count":0,"forks_count":9,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-12-21T07:03:44.781Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/fluree.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-10-29T20:51:42.000Z","updated_at":"2025-12-18T23:15:29.000Z","dependencies_parsed_at":"2023-01-21T12:17:57.297Z","dependency_job_id":"53cda7a3-4c6c-43ff-821d-5f4256eec08c","html_url":"https://github.com/fluree/developers-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fluree/developers-site","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluree%2Fdevelopers-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluree%2Fdevelopers-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluree%2Fdevelopers-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluree%2Fdevelopers-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fluree","download_url":"https://codeload.github.com/fluree/developers-site/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluree%2Fdevelopers-site/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28846058,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T13:02:32.985Z","status":"ssl_error","status_checked_at":"2026-01-28T13:02:04.945Z","response_time":57,"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":[],"created_at":"2026-01-28T14:12:53.209Z","updated_at":"2026-01-28T14:12:53.763Z","avatar_url":"https://github.com/fluree.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fluree Developer Docs\n\nWelcome to the Fluree docs! This readme will detail how to run the docs,\nraise an issue, and submit changes.\n\nThe docs are built using [Docusaurus](https://docusaurus.io/).\n\n## Run the Docs Locally\n\nClone the project\n\n```bash\ngit clone https://github.com/fluree/flhubee\n```\n\nGo to the project directory\n\n```bash\ncd apps/docs-site\n```\n\nInstall dependencies\n\n```bash\nbun install\n```\n\nStart the server\n\n```bash\nbun run docs-site\n```\n\n## Docusaurus Customizations\n\nWe've customized the basic Docusaurus installation to enhance the docs\nexperience. These customizations require you to use MDX files, and you may need\nto explicitly use docusaurus components for elements that you previously could\ndenote with markdown syntax. One such component is `Admonition`, for creating\nwarning or info blocks and the like. Here's an example:\n\n```javascript\nimport Admonition from \"@theme/Admonition\";\n\n\u003cAdmonition type=\"caution\"\u003e\n  In real-world usage you'll want to use _IRIs_ for `\"@id\"` values, a topic\n  we'll cover in the next chapter. We'll keep formatting @id's this way for the\n  time being, but if for some reason you stop the tutorial here just be aware\n  that it'll be important to learn how to work with IRIs.\n\u003c/Admonition\u003e;\n```\n\n### Code Hike\n\nYou can use [Code Hike](https://codehike.org/) to spice up code snippets with\nfeatures like:\n\n- Highlights\n- Filenames and tabs\n- Annotations\n- Spotlight\n\nSee the code hike docs for more details.\n\n### Fluree Sandbox\n\nThe Sandbox lets you transact against an in-memory Fluree database. This\ndatabase persists across a browser session, but does not survive a page refresh.\n\nTo use the sandbox:\n\n1. Use the `.mdx` file extension for your file\n2. Add the following at the top:\n\n   ```javascript\n   import SandboxDrawer from \"@site/src/components/sandbox_drawer/SandboxDrawer.jsx\";\n   ```\n\n3. Add the following at the bottom:\n\n   ```javascript\n   \u003cSandboxDrawer /\u003e\n   ```\n\n4. The `SandboxDrawer` component can take in 3 props, which are optional:\n\n- `defaultValue` will set the initial value of the drawer input editor. This is generally a JSON object, but could also be a string.\n- `defaultContext` takes a JSON object and will set the default context used in the fluree ledger.\n- `seedTransactions` takes an array of transactions which will be run against the ledger when the drawer component mounts. Accepts an array of objects (JSON).\n\n5. In conjunction with the `SandboxDrawer`, you can use the `SandboxButton` to populate the drawer's contents. To use the `SandboxButton`, first add the import statement:\n\n   ```javascript\n   import SandboxButton from \"@site/src/components/sandbox_drawer/SandboxButton.jsx\";\n   ```\n\n   Then, add `\u003cSandboxButton /\u003e` directly above a codeblock in the markdown file, such as:\n\n   ````javascript\n   (\u003cSandboxButton /\u003e)```json\n     {\"some\": \"json\"}\n   ```;\n   ````\n\n### Mermaid\n\nMermaid renders diagrams from plain text. To use Mermaid on a page:\n\n1. Use the `.mdx` file extension for your file\n2. Add the following at the top:\n\n   ```javascript\n   import { FlureeMermaid } from \"@site/src/components/Mermaid/FlureeMermaid.jsx\";\n   ```\n\n3. Include a chart component with something like the following:\n\n```javascript\n\u003cFlureeMermaid\n  chart={`graph TB\n  j(_:f100) --\u003e|\"@id\"| jid(_:f100)\n  j --\u003e|name| jn(Jack)\n  j --\u003e|species| sp1(Mongolian death worm)\n  j --\u003e|bestFriend| l\n  l(_:f101) --\u003e|\"@id\"| lid(_:f101)\n  l --\u003e|name| ln(Lucia)\n  l --\u003e|species| sp2(Mongolian death worm)\n  l --\u003e|bestFriend| j\n`}\n/\u003e\n```\n\n## Contributing\n\nIf you notice any issues on the mark down files please feel free to open an issue\non GitHub, contributions are always welcome!\n\n## Connect with the Fluree Team\n\nTo connect directly with the Fluree team join our [Discord](https://discord.gg/pgjsvPa9Nm).\n\nVisit our [Fluree](http://flur.ee/) website.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluree%2Fdevelopers-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffluree%2Fdevelopers-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluree%2Fdevelopers-site/lists"}