{"id":50969290,"url":"https://github.com/cannlytics/cannlytics-docs","last_synced_at":"2026-06-19T00:03:56.245Z","repository":{"id":260061144,"uuid":"408601848","full_name":"cannlytics/cannlytics-docs","owner":"cannlytics","description":"🔥 Cannlytics 📚 Documentation","archived":false,"fork":false,"pushed_at":"2024-08-20T06:35:39.000Z","size":8273,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-24T00:32:18.597Z","etag":null,"topics":["cannabis","cannabis-api","cannabis-app","cannabis-data","cannabisapp","django","metrc","python","statistics"],"latest_commit_sha":null,"homepage":"https://docs.cannlytics.com","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cannlytics.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}},"created_at":"2021-09-20T21:12:59.000Z","updated_at":"2024-08-20T06:35:43.000Z","dependencies_parsed_at":"2024-10-29T10:06:13.323Z","dependency_job_id":null,"html_url":"https://github.com/cannlytics/cannlytics-docs","commit_stats":{"total_commits":6,"total_committers":1,"mean_commits":6.0,"dds":0.0,"last_synced_commit":"73cf59f5b452687ca0fa4733d9556eeebf92efd3"},"previous_names":["cannlytics/cannlytics-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cannlytics/cannlytics-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cannlytics%2Fcannlytics-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cannlytics%2Fcannlytics-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cannlytics%2Fcannlytics-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cannlytics%2Fcannlytics-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cannlytics","download_url":"https://codeload.github.com/cannlytics/cannlytics-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cannlytics%2Fcannlytics-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34511622,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-18T02:00:06.871Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["cannabis","cannabis-api","cannabis-app","cannabis-data","cannabisapp","django","metrc","python","statistics"],"created_at":"2026-06-19T00:03:55.415Z","updated_at":"2026-06-19T00:03:56.238Z","avatar_url":"https://github.com/cannlytics.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation \u003ca name=\"documentation\"\u003e\u003c/a\u003e\n\nYou can read the Cannlytics documentation at [https://docs.cannlytics.com](https://docs.cannlytics.com).\n\n## Writing documentation\n\nDocumentation for Cannlytics is written in [Markdown](https://guides.github.com/features/mastering-markdown/) and lives in the `docs` folder. The configuration for the documentation is contained within `mkdocs.yml`. Building the documentation requires [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) and [Docker](https://www.docker.com/get-started).\n\n## Building the documentation\n\nFirst, you will need to pull and build the Material for MKDocs Docker image:\n\n```shell\ndocker pull squidfunk/mkdocs-material\ndocker build -t squidfunk/mkdocs-material docs\n```\n\nor\n\n```shell\nnpm run install\n```\n\nYou will also need to install the Python dependencies for the documentation:\n\n```shell\npip install -r docs/requirements.txt\n```\n\nOnce you have a copy of the Docker image, you can preview the documentation as you write:\n\n```shell\ndocker run --rm -it -p 8000:8000 -v \"%cd%\":/docs squidfunk/mkdocs-material\n```\n\nor\n\n```shell\nnpm run start\n```\n\nYou can preview the documentation at \u003chttp://localhost:8000/\u003e while you develop.\n\n!!! note\n\n    There is [a namespace conflict between `django-livereload-server` and `livereload`](https://gist.github.com/hangtwenty/f53b3867db1e33780505ccafd8d2eef0), so you need to be careful when and where you install Python requirements. If you run into a `django-livereload-server` import error, first check that `PRODUCTION=False` in your `.env` file and then follow [these instructions](https://gist.github.com/hangtwenty/f53b3867db1e33780505ccafd8d2eef0) to uninstall `livereload` and reinstall  `django-livereload-server`.\n\n## Publishing documentation\n\nWhen you are ready, you can build the documentation with:\n\n```shell\nnpm run build\n```\n\nFinally, you can publish the documentation with:\n\n```shell\nnpm run publish\n```\n\nCongratulations, you can now read the documentation at [https://docs.cannlytics.com](https://docs.cannlytics.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcannlytics%2Fcannlytics-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcannlytics%2Fcannlytics-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcannlytics%2Fcannlytics-docs/lists"}