{"id":19721981,"url":"https://github.com/datajoint/datajoint-docs","last_synced_at":"2025-04-29T22:30:32.825Z","repository":{"id":59713937,"uuid":"524153859","full_name":"datajoint/datajoint-docs","owner":"datajoint","description":"Landing Page for DataJoint Documentation","archived":false,"fork":false,"pushed_at":"2025-04-15T11:18:12.000Z","size":5800,"stargazers_count":4,"open_issues_count":3,"forks_count":11,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-15T12:26:13.859Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://datajoint.com/docs","language":"CSS","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/datajoint.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}},"created_at":"2022-08-12T16:23:06.000Z","updated_at":"2025-02-05T21:06:00.000Z","dependencies_parsed_at":"2023-08-21T19:25:34.023Z","dependency_job_id":"af4fef44-1bc8-4251-b232-5a2edd36b180","html_url":"https://github.com/datajoint/datajoint-docs","commit_stats":null,"previous_names":["datajoint/datajoint-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datajoint%2Fdatajoint-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datajoint%2Fdatajoint-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datajoint%2Fdatajoint-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datajoint%2Fdatajoint-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datajoint","download_url":"https://codeload.github.com/datajoint/datajoint-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251592897,"owners_count":21614440,"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":[],"created_at":"2024-11-11T23:16:08.218Z","updated_at":"2025-04-29T22:30:32.802Z","avatar_url":"https://github.com/datajoint.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DataJoint Documentation\n\nThis is the home for DataJoint software documentation as hosted at https://docs.datajoint.com\n## VSCode Linter Extensions and Settings\n\nThe following extensions were used in developing these docs, with the corresponding\nsettings files:\n\n- Recommended extensions are already specified in `.vscode/extensions.json`, it will ask you to install them when you open the project if you haven't installed them.\n- settings in `.vscode/settings.json`\n- [MarkdownLinter](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint):\n  - `.markdownlint.yaml` establishes settings for various\n  [linter rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md)\n  - `.vscode/settings.json` formatting on save to fix linting\n\n- [CSpell](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker): `cspell.json`\nhas various ignored words.\n\n- [ReWrap](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap): `.vscode/settings.json` allows toggling\nautomated hard wrapping for files at 88 characters. This can also be keymapped to be\nperformed on individual paragraphs, see documentation.\n\n## With Virtual Environment\n\nconda\n```bash\nconda create -n djdocs -y\nconda activate djdocs\n```\nvenv\n```bash\npython -m venv .venv\nsource .venv/bin/activate\n```\n\nThen install the required packages:\n```bash\npip install -r pip_requirements.txt\n```\n\nRun mkdocs at: http://127.0.0.1:8000/\n```bash\n# It will automatically reload the docs when changes are made\nmkdocs serve --config-file ./mkdocs.yaml\n```\n\n## With Docker\n\n\u003e We mostly use Docker to simplify docs deployment\n\nEnsure you have `Docker` and `Docker Compose` installed.\n\nThen run the following:\n```bash\n# It will automatically reload the docs when changes are made\nMODE=\"LIVE\" docker compose up --build\n```\n\nNavigate to http://127.0.0.1:8000/ to preview the changes.\n\nThis setup supports live-reloading so all that is needed is to save the markdown files\nand/or `mkdocs.yaml` file to trigger a reload.\n\n## Mkdocs Warning Explanation\n\n\u003e TL;DR: We need to do it this way for hosting, please keep it as is.\n\n```log\nWARNING -  A reference to 'core/datajoint-python/' is included in the 'nav' configuration, which is not found\n           in the documentation files.\nINFO    -  Doc file 'index.md' contains an unrecognized relative link './core/datajoint-python/', it was left\n           as is.\n```\n\n- We use reverse proxy to proxy our docs sites, here is the proxy flow:\n  - You hit `datajoint.com/*` on your browser\n  - It'll bring you to the reverse proxy server first, that you wouldn't notice\n  - when your URL ends with:\n    - `/` is the landing/navigation page hosted by datajoint/datajoint-docs's github pages\n    - `/core/datajoint-python/` is the actual docs site hosted by datajoint/datajoint-python's github pages\n    - `/elements/element-*/` is the actual docs site hosted by each element's github pages\n\n\n```log\nWARNING -  Doc file 'partnerships/openephysgui.md' contains a link\n           '../../images/community-partnerships-openephysgui-logo.png', but the target\n           '../images/community-partnerships-openephysgui-logo.png' is not found among documentation files.\n           Did you mean '../images/community-partnerships-openephysgui-logo.png'?\n```\n- We use Github Pages to host our docs, the image references needs to follow the mkdocs's build directory structure, under `site/` directory once you run mkdocs.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatajoint%2Fdatajoint-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatajoint%2Fdatajoint-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatajoint%2Fdatajoint-docs/lists"}