{"id":19274417,"url":"https://github.com/barttc/django-actual-admin-docs","last_synced_at":"2025-04-11T20:41:12.541Z","repository":{"id":261260468,"uuid":"883812561","full_name":"bartTC/django-actual-admin-docs","owner":"bartTC","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-06T11:46:10.000Z","size":436,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-21T13:45:36.552Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/bartTC.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2024-11-05T16:04:38.000Z","updated_at":"2025-01-13T19:54:37.000Z","dependencies_parsed_at":"2024-11-05T16:17:32.086Z","dependency_job_id":"f2b1bd4b-fe86-4194-aab7-2f64fe93cbfb","html_url":"https://github.com/bartTC/django-actual-admin-docs","commit_stats":null,"previous_names":["barttc/django-actual-admin-docs"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bartTC%2Fdjango-actual-admin-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bartTC%2Fdjango-actual-admin-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bartTC%2Fdjango-actual-admin-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bartTC%2Fdjango-actual-admin-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bartTC","download_url":"https://codeload.github.com/bartTC/django-actual-admin-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248478686,"owners_count":21110748,"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-09T20:46:07.831Z","updated_at":"2025-04-11T20:41:12.506Z","avatar_url":"https://github.com/bartTC.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# django-actual-admin-docs\n\nRender Markdown documentation directly in the Django admin`.\n\n- Support for nested subfolders\n- Comprehensive Markdown format (link to which spec)\n- Provides default styles for Markdown rendering\n\n## Installation\n\n1. Install the `django-actual-admin-docs` package. If you have `pygments` installed, code blocks are automatically highlighted.\n\n2. Add `actual_admin_docs` to your `INSTALLED_APPS` setting:\n\n   ```python \n   INSTALLED_APPS = [\n     \"django.contrib.admin\",\n     \"actual_admin_docs\",\n     ...\n   ]\n   ```\n   \n3. Add the documentation urlpattern, above your admin urls:\n\n   ```python\n   from django.contrib import admin\n   from django.urls import include, path\n   \n   urlpatterns = [\n       path(\"admin/docs/\", include(\"actual_admin_docs.urls\")),\n       path(\"admin/\", admin.site.urls),\n   ]\n   ```\n4. Add a `DOCS_ROOT` setting which should be a `pathlib.Path` pointing to the docs directory:\n\n   ```python \n   DOCS_ROOT = BASE_DIR / \"docs\"\n   ```\n\n## Documentation folder structure\n\nYou can use folders, subfolders, files in folders, etc.\n\n```\n🗂 docs/\n│\n├── 🗂 subfolder   \n│   │   \n│   ├── 🗂 subfolder with spaces\n│   │   └── 📝 another-file.md\n│   │ \n│   ├── 📝 another-file.md\n│   └── 📝 index.md\n│\n├── 🗂 img    \n│   └── 🌁 cat_studying_glasses.jpg\n│\n├── 📝 index.md\n└── 📝 markdown-sample.md\n```\n\nUse regular Markdown links to link to other documents or objects:\n\n```markdown\nA link to [another document](./markdown-sample.md) is just a regular Markdown link. Documents in subdirectories [are supported too](./subfolder/another-file.md).\n\nFor images, downloads etc. use regular markdown markup too:\n\n![A cat judging your code](./img/cat_studying_glasses.jpg)\n[Click to download](./img/./img/cat_studying_glasses.jpg)\n```\n\n## Custom CSS\n\nOverwrite the `actual-admin-docs.css` file to add your custom styles.\n\n\n-----\n\n# 🤺 Local Development\n\n```bash\n$ poetry install\n$ poetry run pytest\n$ DJANGO_SETTINGS_MODULE=actual_admin_docs.tests.testproject.settings poetry run django-admin runserver\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarttc%2Fdjango-actual-admin-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbarttc%2Fdjango-actual-admin-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarttc%2Fdjango-actual-admin-docs/lists"}