{"id":13511715,"url":"https://github.com/mimblewimble/docs","last_synced_at":"2025-06-15T12:08:28.903Z","repository":{"id":40649831,"uuid":"114822034","full_name":"mimblewimble/docs","owner":"mimblewimble","description":"Documentation for Grin and Mimblewimble","archived":false,"fork":false,"pushed_at":"2024-04-05T13:17:06.000Z","size":5868,"stargazers_count":305,"open_issues_count":7,"forks_count":87,"subscribers_count":52,"default_branch":"master","last_synced_at":"2024-05-22T19:30:19.291Z","etag":null,"topics":["documentation","grin","mimblewimble"],"latest_commit_sha":null,"homepage":"https://docs.grin.mw","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/mimblewimble.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":"2017-12-19T23:40:06.000Z","updated_at":"2024-08-01T04:47:10.732Z","dependencies_parsed_at":"2024-01-13T01:39:47.974Z","dependency_job_id":"155a168e-ab45-42ff-963a-deba998e8b4b","html_url":"https://github.com/mimblewimble/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mimblewimble/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mimblewimble%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mimblewimble%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mimblewimble%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mimblewimble%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mimblewimble","download_url":"https://codeload.github.com/mimblewimble/docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mimblewimble%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259971391,"owners_count":22940013,"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":["documentation","grin","mimblewimble"],"created_at":"2024-08-01T03:01:08.059Z","updated_at":"2025-06-15T12:08:28.881Z","avatar_url":"https://github.com/mimblewimble.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# Grin Documentation\n\n## Requirements\n\nClone repo and navigate to directory:\n\n```bash\ngit clone --recursive https://github.com/mimblewimble/docs.git\n```\n\n### Local\n\nInstall the following software:\n\n- [MkDocs](https://www.mkdocs.org/#installation)\n- [MkDocs Material theme](https://squidfunk.github.io/mkdocs-material/getting-started/)\n\nThen start the local Mkdocs server:\n\n```bash\nmkdocs serve\n```\n\n### Container\n\nStart the local MkDocs server:\n\n```bash\ndocker build -t docs -f Containerfile .\ndocker run -p 8000:8000 -v ./:/app/:ro docs:latest\n```\n\n## Test\n\nVisit `http://localhost:8000` to see live changes.\n\nWhen ready, push changes to your forked repo and then submit a PR.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmimblewimble%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmimblewimble%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmimblewimble%2Fdocs/lists"}