{"id":13548802,"url":"https://github.com/aksakalli/jekyll-doc-theme","last_synced_at":"2025-04-04T18:10:02.002Z","repository":{"id":20598097,"uuid":"90177206","full_name":"aksakalli/jekyll-doc-theme","owner":"aksakalli","description":"Jekyll theme for creating project documentation websites","archived":false,"fork":false,"pushed_at":"2024-02-29T02:06:16.000Z","size":3157,"stargazers_count":293,"open_issues_count":8,"forks_count":261,"subscribers_count":16,"default_branch":"gh-pages","last_synced_at":"2025-03-28T17:10:07.294Z","etag":null,"topics":["bootstrap","jekyll","jekyll-theme","sass","static-site","static-site-generator","theme"],"latest_commit_sha":null,"homepage":"https://aksakalli.github.io/jekyll-doc-theme/","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/aksakalli.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":"2017-05-03T17:48:59.000Z","updated_at":"2025-02-27T11:11:41.000Z","dependencies_parsed_at":"2024-08-01T12:16:15.623Z","dependency_job_id":"42a51677-43c9-4d98-b124-663626eff366","html_url":"https://github.com/aksakalli/jekyll-doc-theme","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/aksakalli%2Fjekyll-doc-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aksakalli%2Fjekyll-doc-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aksakalli%2Fjekyll-doc-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aksakalli%2Fjekyll-doc-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aksakalli","download_url":"https://codeload.github.com/aksakalli/jekyll-doc-theme/tar.gz/refs/heads/gh-pages","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247226215,"owners_count":20904465,"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":["bootstrap","jekyll","jekyll-theme","sass","static-site","static-site-generator","theme"],"created_at":"2024-08-01T12:01:14.645Z","updated_at":"2025-04-04T18:10:01.986Z","avatar_url":"https://github.com/aksakalli.png","language":"SCSS","funding_links":[],"categories":["CSS","bootstrap"],"sub_categories":[],"readme":"# Jekyll Doc Theme\n\nGo to [the website](https://aksakalli.github.io/jekyll-doc-theme/) for detailed information and demo.\n\n## Running locally\n\nYou need Ruby and gem before starting, then:\n\n```bash\n# install bundler\ngem install bundler\n\n# clone the project\ngit clone https://github.com/aksakalli/jekyll-doc-theme.git\ncd jekyll-doc-theme\n\n# install dependencies\nbundle install\n\n# run jekyll with dependencies\nbundle exec jekyll serve\n```\n\n### Theme Assets\n\nAs of the move to support [Github Pages](https://pages.github.com/) a number of files have been relocated to the `/asset` folder.\n- css/\n- fonts/\n- img/\n- js/\n- 404.html\n- allposts.html\n- search.json\n\n## Docker\n\nAlternatively, you can deploy it using the multi-stage [Dockerfile](Dockerfile)\nthat serves files from Nginx for better performance in production.\n\nBuild the image for your site's `JEKYLL_BASEURL`:\n\n```\ndocker build --build-arg JEKYLL_BASEURL=\"/your-base/url\" -t jekyll-doc-theme .\n```\n\n(or leave it empty for root: `JEKYLL_BASEURL=\"\"`) and serve it:\n\n```\ndocker run -p 8080:80 jekyll-doc-theme\n```\n\n## Github Pages\n\nThe theme is also available to [Github Pages](https://pages.github.com/) by making use of the [Remote Theme](https://github.com/benbalter/jekyll-remote-theme) plugin:\n\n**Gemfile**\n```\n# If you want to use GitHub Pages, remove the \"gem \"jekyll\"\" above and\n# uncomment the line below. To upgrade, run `bundle update github-pages`.\ngem \"github-pages\", group: :jekyll_plugins\n```\n\n**_config.yml**\n```\n# Configure the remote_theme plugin with the gh-pages branch\n# or the specific tag\nremote_theme: aksakalli/jekyll-doc-theme@gh-pages   \n```\n\n### Theme Assets\n\nFiles from your project will override any theme file with the same name.  For example, the most comment use case for this, would be to modify your sites theme or colors.   To do this, the following steps should be taken:\n\n1) Copy the contents of the `aksakalli/jekyll-doc-theme/asset/css/main.scss` to your own project (maintaining folder structure)\n2) Modify the variables you wish to use prior to the import statements, for example:\n\n```\n// Bootstrap variable overrides\n$grid-gutter-width: 30px !default;\n$container-desktop: (900px + $grid-gutter-width) !default;\n$container-large-desktop: (900px + $grid-gutter-width) !default;\n\n@import // Original import statement\n  {% if site.bootwatch %}\n    \"bootswatch/{{site.bootwatch | downcase}}/variables\",\n  {% endif %}\n\n  \"bootstrap\",\n\n  {% if site.bootwatch %}\n    \"bootswatch/{{site.bootwatch | downcase}}/bootswatch\",\n  {% endif %}\n\n  \"syntax-highlighting\",\n  \"typeahead\",\n  \"jekyll-doc-theme\"\n;\n\n// More custom overrides.\n```\n\n3) Import or override any other theme styles after the standard imports\n\n## Projects using Jekyll Doc Theme\n\n* http://teavm.org/\n* https://ogb.stanford.edu/\n* https://griddb.org/\n* https://su2code.github.io/\n* https://contextmapper.org/\n* https://launchany.github.io/mvd-template/\n* https://knowit.github.io/kubernetes-workshop/\n* https://rec.danmuji.org/\n* https://nethesis.github.io/icaro/\n* http://ai.cs.ucl.ac.uk/\n* http://tizonia.org\n* https://lakka-switch.github.io/documentation/\n* https://cs.anu.edu.au/cybersec/issisp2018/\n* http://www.channotation.org/\n* http://nemo.apache.org/\n* https://csuf-acm.github.io/\n* https://extemporelang.github.io/\n* https://media-ed-online.github.io/intro-web-dev-2018spr/\n* https://midlevel.github.io/MLAPI/\n* https://pulp-platform.github.io/ariane/docs/home/\n* https://koopjs.github.io/\n* https://developer.apiture.com/\n* https://contextmapper.github.io/\n* https://www.bruttin.com/CosmosDbExplorer/\n* http://mosaic-lopow.github.io/dash7-ap-open-source-stack/\n* http://www.vstream.ml/\n* http://docs.fronthack.com/\n* https://repaircafeportsmouth.org.uk/\n* http://brotherskeeperkenya.com/\n* https://hschne.at/Fluentast/\n* https://zoe-analytics.eu/\n* https://uli.kmz-brno.cz/\n* https://lime.software/\n* https://weft.aka.farm\n* https://microros.github.io/\n* https://citystoriesucla.github.io/citystories-LA-docs\n* http://lessrt.org/\n* http://kivik.io/\n* https://www.iot-kit.nl/\n* http://justindietz.com/\n* https://universalsplitscreen.github.io/\n* https://docs.oneflowcloud.com/\n* https://actlist.silentsoft.org/\n* https://teevid.github.io\n* https://developer.ipums.org\n* https://osmpersia.github.io (right-to-left)\n* https://ecmlpkdd2019.org\n* https://idle.land\n* https://mqless.com\n* https://muict-seru.github.io/\n* https://www.invoice-x.org\n* https://www.devops.geek.nz\n\n## License\n\nReleased under [the MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faksakalli%2Fjekyll-doc-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faksakalli%2Fjekyll-doc-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faksakalli%2Fjekyll-doc-theme/lists"}