{"id":26519990,"url":"https://github.com/aasmpro/gruvdoc","last_synced_at":"2025-07-29T09:35:15.450Z","repository":{"id":174583335,"uuid":"401836612","full_name":"aasmpro/gruvdoc","owner":"aasmpro","description":"Pre-configured MkDocs project with GruvBox colors and JetBrainsMono font.","archived":false,"fork":false,"pushed_at":"2022-10-17T07:05:12.000Z","size":2493,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-07T04:41:17.353Z","etag":null,"topics":["gruvbox","hacktoberfest","mkdocs","python","theme"],"latest_commit_sha":null,"homepage":"https://abolfazlamiri.ir/gruvdoc/","language":null,"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/aasmpro.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-08-31T20:36:05.000Z","updated_at":"2024-07-20T10:51:35.000Z","dependencies_parsed_at":"2023-07-30T00:31:01.068Z","dependency_job_id":null,"html_url":"https://github.com/aasmpro/gruvdoc","commit_stats":null,"previous_names":["aasmpro/gruvdoc"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/aasmpro/gruvdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aasmpro%2Fgruvdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aasmpro%2Fgruvdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aasmpro%2Fgruvdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aasmpro%2Fgruvdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aasmpro","download_url":"https://codeload.github.com/aasmpro/gruvdoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aasmpro%2Fgruvdoc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267663072,"owners_count":24123994,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"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":["gruvbox","hacktoberfest","mkdocs","python","theme"],"created_at":"2025-03-21T11:37:14.409Z","updated_at":"2025-07-29T09:35:15.437Z","avatar_url":"https://github.com/aasmpro.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"## [GruvDoc](https://abolfazlamiri.ir/gruvdoc/)\nGruvDoc is pre-configured [MkDocs](https://www.mkdocs.org/) project with all the must useful extensions and tweaks needed, just Fork, Change and Push!\n\ncheck [Demo](https://abolfazlamiri.ir/gruvdoc/demo/abbreviations/) or [Docs](https://abolfazlamiri.ir/gruvdoc/docs/colors/) for more information.\n\n### Features\n- GruvDoc is all extra config files, anything can be [changed](https://abolfazlamiri.ir/gruvdoc/#you-dont-want-tweaks) easily.\n- Tweaks [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) under the hood!\n- [GruvBox](https://abolfazlamiri.ir/gruvdoc/docs/colors/) color palette with 24 different colors for both primary and accent.\n- [JetBrainsMono](https://abolfazlamiri.ir/gruvdoc/docs/fonts/) font.\n- Simple, pre-configured [mkdocs.yml](https://github.com/aasmpro/gruvdoc/blob/master/mkdocs.yml) file.\n- [Github](https://github.com/aasmpro/gruvdoc/blob/master/.github/workflows/gruvdoc.yml) / [Gitlab](https://github.com/aasmpro/gruvdoc/blob/master/.gitlab-ci.yml) Workflows included for auto Deployment!\n- Including [Styles](https://abolfazlamiri.ir/gruvdoc/docs/styles/) and custom [Utils](https://abolfazlamiri.ir/gruvdoc/docs/utils/).\n\n### Usage\n[Fork](https://github.com/aasmpro/gruvdoc/fork) GruvDoc github repo and Clone it or Clone the main repo:\n```\ngit clone https://github.com/aasmpro/gruvdoc.git\n```\n\u003e by [Forking](https://github.com/aasmpro/gruvdoc/fork) you don't need to create and set new repo.\n\ncreate a virtual environment and install packages:\n```\npip install -r requirements/gruvdoc.txt\n```\nserve your local version and start editing!\n```\nmkdocs serve\n```\nwhen you are done, commit and push changes. workflows will take care of deployments.\n\ncheck [mkdocs-material/publishing](https://squidfunk.github.io/mkdocs-material/publishing-your-site/) for more information.\n\n#### In another repo\nif you want to add GruvDoc in another project:\n\n- copy `docs` folder to your project\n- copy `mkdocs.yml` file to your project\n- copy `requirements` folder to your project\n- copy `.github/workflows/gruvdoc.yml` or `.gitlab-ci.yml` for workflows\n \n\n### You don't want tweaks?!\nyou rather using GrubDoc without its tweaked theme? no problem!\njust comment extra css section in `mkdocs.yml` file:\n```yaml\n## Extra css files\n### comment these lines,\n### if you want to use default material theme\nextra_css:\n  - assets/stylesheets/fonts.css\n  - assets/stylesheets/vars.css\n  - assets/stylesheets/scheme.css\n  - assets/stylesheets/primary.css\n  - assets/stylesheets/accent.css\n  - assets/stylesheets/admonitions.css\n  - assets/stylesheets/utils.css\n  - assets/stylesheets/styles.css\n```\nand then set your palette:\n```yaml\n## Theme settings\ntheme:\n  name: material\n  ### comment these lines,\n  ### if you want to use default material theme\n  palette:\n    scheme: gruvbox\n    primary: green\n    accent: green\n  ### uncomment to use default material theme\n  # palette:\n  #   scheme: default\n```\nyou can change anything by editing only `mkdocs.yml` file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faasmpro%2Fgruvdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faasmpro%2Fgruvdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faasmpro%2Fgruvdoc/lists"}