{"id":13549286,"url":"https://github.com/cfpb/DOCter","last_synced_at":"2025-04-02T22:31:35.320Z","repository":{"id":11984680,"uuid":"14559867","full_name":"cfpb/DOCter","owner":"cfpb","description":"A Jekyll template for project documentation","archived":false,"fork":false,"pushed_at":"2020-12-27T03:24:00.000Z","size":287,"stargazers_count":106,"open_issues_count":5,"forks_count":88,"subscribers_count":20,"default_branch":"gh-pages","last_synced_at":"2025-03-23T22:11:22.994Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://cfpb.github.io/DOCter/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cfpb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-11-20T15:12:16.000Z","updated_at":"2025-03-20T18:00:07.000Z","dependencies_parsed_at":"2022-09-07T11:51:58.182Z","dependency_job_id":null,"html_url":"https://github.com/cfpb/DOCter","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/cfpb%2FDOCter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2FDOCter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2FDOCter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2FDOCter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cfpb","download_url":"https://codeload.github.com/cfpb/DOCter/tar.gz/refs/heads/gh-pages","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246905121,"owners_count":20852812,"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-08-01T12:01:20.247Z","updated_at":"2025-04-02T22:31:34.618Z","avatar_url":"https://github.com/cfpb.png","language":"CSS","funding_links":[],"categories":["CSS","others"],"sub_categories":[],"readme":"# DOCter\n\nDOCter is a [Jekyll](http://jekyllrb.com/) template for quickly building out project pages and documentation.\n\n![DOCter Screenshot](https://github.com/ascott1/DOCter/blob/gh-pages/assets/img/screenshot.png?raw=true)\n\n[See the demo](http://cfpb.github.io/DOCter/)\n\n## To run DOCter locally\n\nDOCter needs Jekyll and other dependencies to run locally. These can be installed with Bundler by running the following commands.\n\n```\ngem install bundler\nbundle install\n```\n\nFork and clone the repo:\n\n```\ngit clone git@github.com:cfpb/DOCter.git\ncd DOCter\n```\nRun Jekyll:\n\n```\nbundle exec jekyll serve --watch --baseurl ''\n```\n\nOpen it up in your browser: \u003chttp://localhost:4000/\u003e\n\n\n## `_config.yml`\n\nOptions within the `_config.yml` file allow you to control the site's title, subtitle, logo, author information, and the left column navigation.\n\n\n### Project Page URL Structure\n\n**This is an excerpt from the [Jekyll docs](http://jekyllrb.com/docs/github-pages/) on configuring your URL for Project Pages.**\n\nSometimes it's nice to preview your Jekyll site before you push your `gh-pages` branch to GitHub. However, the subdirectory-like URL structure GitHub uses for Project Pages complicates the proper resolution of URLs. Here is an approach to utilizing the GitHub Project Page URL structure (`username.github.io/project-name/`) whilst maintaining the ability to preview your Jekyll site locally.\n\n1. In `_config.yml`, set the `baseurl` option to `/project-name` -- note the leading slash and the **absence** of a trailing slash.\n2. When referencing JS or CSS files, do it like this: `{{ site.baseurl }}/path/to/css.css` -- note the slash immediately following the variable (just before \"path\").\n3. When doing permalinks or internal links, do it like this: `{{ site.baseurl }}{{ post.url }}` -- note that there is **no** slash between the two variables.\n4. Finally, if you'd like to preview your site before committing/deploying using `jekyll serve`, be sure to pass an **empty string** to the `--baseurl` option, so that you can view everything at `localhost:4000` normally (without `/project-name` at the beginning): `jekyll serve --baseurl ''`\n\nThis way, you can preview your site locally from the site root on localhost, but when GitHub generates your pages from the gh-pages branch all the URLs will start with `/project-name` and resolve properly.\n\n\n## Offline support\n\nDOCter provides optional offline support via a [Service Worker](http://www.html5rocks.com/en/tutorials/service-worker/introduction/). This means that, when enabled, after an initial load of your DOCter site, a cached version will be available offline in some modern browsers.\n\n**To enable offline caching:**\n\nin `_config.yml`: set `offline_cache` to `true` (defaults to `false`)\n\n**To update the cached version of your site:**\n\nin `_config.yml`: change the value of `cache_name` (this should be done with every significant update to the site)\n\n**To add additional files to the cache:**\n\nin `sw.js`: update the `filesToCache` array\n\n\n## License\n\nThe project is in the public domain, and all contributions to it will be released as such. By submitting a pull request, you are agreeing to waive all rights to your contribution under the terms of the [CC0 Public Domain Dedication](http://creativecommons.org/publicdomain/zero/1.0/).\n\nIf you contribute the open source work of others, please mark it clearly in your pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2FDOCter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcfpb%2FDOCter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2FDOCter/lists"}