{"id":15021041,"url":"https://github.com/alexander-heimbuch/millidocs","last_synced_at":"2025-10-27T05:30:56.967Z","repository":{"id":55680770,"uuid":"93761550","full_name":"alexander-heimbuch/millidocs","owner":"alexander-heimbuch","description":"A simple documentation theme for Jekyll.","archived":false,"fork":false,"pushed_at":"2022-05-10T06:06:03.000Z","size":46,"stargazers_count":44,"open_issues_count":0,"forks_count":25,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T02:33:46.535Z","etag":null,"topics":["documentation","jekyll","jekyll-theme"],"latest_commit_sha":null,"homepage":"http://alexander.heimbu.ch/millidocs/","language":"SCSS","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/alexander-heimbuch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"ko_fi":"alexanderheimbuch","custom":"https://www.amazon.de/hz/wishlist/ls/237T6KS5438PE"}},"created_at":"2017-06-08T14:52:57.000Z","updated_at":"2024-07-04T14:23:12.000Z","dependencies_parsed_at":"2022-08-15T06:20:43.423Z","dependency_job_id":null,"html_url":"https://github.com/alexander-heimbuch/millidocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander-heimbuch%2Fmillidocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander-heimbuch%2Fmillidocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander-heimbuch%2Fmillidocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander-heimbuch%2Fmillidocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexander-heimbuch","download_url":"https://codeload.github.com/alexander-heimbuch/millidocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238437622,"owners_count":19472449,"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","jekyll","jekyll-theme"],"created_at":"2024-09-24T19:56:03.914Z","updated_at":"2025-10-27T05:30:56.556Z","avatar_url":"https://github.com/alexander-heimbuch.png","language":"SCSS","funding_links":["https://ko-fi.com/alexanderheimbuch","https://www.amazon.de/hz/wishlist/ls/237T6KS5438PE"],"categories":[],"sub_categories":[],"readme":"# Millidocs Theme\n\nSimple documentation theme for Jekyll featuring [Milligram CSS framework](http://milligram.io/), [PrismJS syntax highlighter](http://prismjs.com/) and [LunrJS search](https://lunrjs.com/).\n\nOne of the core features is a full text client side search and full responsiveness. It has zero dependencies with other gems and should be easily build with Github.\n\n## Installation\n\nAdd this line to your Jekyll site's `Gemfile`:\n\n```ruby\ngem \"millidocs\"\n```\n\nAdapt your Jekyll site config `_config.yml`:\n\n```yaml\n  title: My Docs Page Title\n  description: MY description\n  url: \"https://base/url/site\"\n  theme: millidocs\n\n  markdown: kramdown\n  kramdown:\n    syntax_highlighter_opts:\n      disable : true\n\n  exclude:\n    - Gemfile\n    - Gemfile.lock\n    - README.md\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install millidocs\n\n\n## Usage\n\n### Github Pages\n\nYou can use this theme by simply adding `remote_theme: alexander-heimbuch/millidocs` to your `_config.yml` (Thanks to @kogli for the hint).\n\n### Available Themes\n\nThis theme is made for _pages_ only and doesn't support _posts_ by default. So the only available layouts are `default` and `page`.\n\n### Navigation\n\nThe navigation supports especially only one level. If you need deep nested structures you propably should use a larger documentation system like [GitBook](https://www.gitbook.com/).\n\nNot every page by default is part of the navigation. If you want to add a page to the navigation you have to add the `navigation` attribute with a desired `index`:\n\n```\n---\nlayout: page\ntitle: Navigation\nnavigation: 2\n---\n```\n\nThe navigation `index` is starting with 1 representing the first item. \n\n\n## Development\n\nTo set up your environment to develop this theme, run `bundle install`.\n\nYour theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.\n\nWhen your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.\n\n## License\n\nThe theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexander-heimbuch%2Fmillidocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexander-heimbuch%2Fmillidocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexander-heimbuch%2Fmillidocs/lists"}