{"id":15017494,"url":"https://github.com/vsoch/mkdocs-jekyll","last_synced_at":"2025-04-10T11:50:49.166Z","repository":{"id":141667844,"uuid":"194412660","full_name":"vsoch/mkdocs-jekyll","owner":"vsoch","description":"The Material theme from MkDocs provided as a Jekyll template, optimized for GitHub Pages","archived":false,"fork":false,"pushed_at":"2024-05-15T17:39:23.000Z","size":800,"stargazers_count":82,"open_issues_count":10,"forks_count":38,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T10:38:52.763Z","etag":null,"topics":["documentation","github-pages","jekyll","mkdocs","mkdocs-material"],"latest_commit_sha":null,"homepage":"https://vsoch.github.io/mkdocs-jekyll/","language":"JavaScript","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/vsoch.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2019-06-29T14:10:11.000Z","updated_at":"2025-03-22T21:56:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"efc23486-a9b7-4a14-810a-252ad60fef99","html_url":"https://github.com/vsoch/mkdocs-jekyll","commit_stats":{"total_commits":75,"total_committers":2,"mean_commits":37.5,"dds":"0.013333333333333308","last_synced_commit":"1469b8702b210f05685f328d32429c38c3cba1b5"},"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsoch%2Fmkdocs-jekyll","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsoch%2Fmkdocs-jekyll/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsoch%2Fmkdocs-jekyll/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsoch%2Fmkdocs-jekyll/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vsoch","download_url":"https://codeload.github.com/vsoch/mkdocs-jekyll/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248215192,"owners_count":21066619,"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","github-pages","jekyll","mkdocs","mkdocs-material"],"created_at":"2024-09-24T19:50:33.893Z","updated_at":"2025-04-10T11:50:49.151Z","avatar_url":"https://github.com/vsoch.png","language":"JavaScript","readme":"# MkDocs Jekyll Theme\n\n[![CircleCI](https://circleci.com/gh/vsoch/mkdocs-jekyll/tree/master.svg?style=svg)](https://circleci.com/gh/vsoch/mkdocs-jekyll/tree/master)\n\n![https://raw.githubusercontent.com/vsoch/mkdocs-jekyll/master/assets/img/mkdocs-jekyll.png](https://raw.githubusercontent.com/vsoch/mkdocs-jekyll/master/assets/img/mkdocs-jekyll.png)\n\nThis is a [starter template](https://vsoch.github.com/mkdocs-jekyll/) for a mkdocs jekyll theme, based on these two\nprevious arts:\n\n - [alexcarpenter/material-jekyll-theme](http://alexcarpenter.github.io/material-jekyll-theme)\n - [squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material)\n\n## Usage\n\n### 1. Get the code\n\nYou can clone the repository right to where you want to host the docs:\n\n```bash\ngit clone https://github.com/vsoch/mkdocs-jekyll.git docs\ncd docs\n```\n\n### 2. Customize\n\nTo edit configuration values, customize the [_config.yml](https://github.com/vsoch/mkdocs-jekyll/blob/master/_config.yml).\nTo add pages, write them into the [pages](https://github.com/vsoch/mkdocs-jekyll/tree/master/pages) folder. \nYou define urls based on the `permalink` attribute in your pages,\nand then add them to the navigation by adding to the content of [_data/toc.myl](https://github.com/vsoch/mkdocs-jekyll/blob/master/_data/toc.yml).\n\n### 3. Options\n\nMost of the configuration values in the [_config.yml](https://github.com/vsoch/mkdocs-jekyll/blob/master/_config.yml) are self explanatory,\nand for more details, see the [about page](https://vsoch.github.io/mkdocs-jekyll/about/)\nrendered on the site.\n\n### 4. Serve\n\nDepending on how you installed jekyll:\n\n```bash\njekyll serve\n# or\nbundle exec jekyll serve\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvsoch%2Fmkdocs-jekyll","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvsoch%2Fmkdocs-jekyll","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvsoch%2Fmkdocs-jekyll/lists"}