{"id":15020982,"url":"https://github.com/quacksouls/tekyll","last_synced_at":"2026-03-07T16:03:30.095Z","repository":{"id":208006438,"uuid":"720320377","full_name":"quacksouls/tekyll","owner":"quacksouls","description":"Jekyll template for documentation","archived":false,"fork":false,"pushed_at":"2023-12-29T08:40:21.000Z","size":249,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-04T13:23:13.096Z","etag":null,"topics":["documentation","jekyll","jekyll-theme","ruby","template"],"latest_commit_sha":null,"homepage":"https://tekyllcoo.github.io/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quacksouls.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":"2023-11-18T05:36:51.000Z","updated_at":"2024-12-06T14:48:47.000Z","dependencies_parsed_at":"2023-11-23T08:33:58.989Z","dependency_job_id":"c1a8e19c-8b16-4df5-bc68-3863fb1ce3e9","html_url":"https://github.com/quacksouls/tekyll","commit_stats":null,"previous_names":["quacksouls/tekyll"],"tags_count":0,"template":true,"template_full_name":"cotes2020/chirpy-starter","purl":"pkg:github/quacksouls/tekyll","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quacksouls%2Ftekyll","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quacksouls%2Ftekyll/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quacksouls%2Ftekyll/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quacksouls%2Ftekyll/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quacksouls","download_url":"https://codeload.github.com/quacksouls/tekyll/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quacksouls%2Ftekyll/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30221193,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T14:02:48.375Z","status":"ssl_error","status_checked_at":"2026-03-07T14:02:43.192Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["documentation","jekyll","jekyll-theme","ruby","template"],"created_at":"2024-09-24T19:55:58.592Z","updated_at":"2026-03-07T16:03:30.074Z","avatar_url":"https://github.com/quacksouls.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Coo template\n\nThis is a template for using the Jekyll theme [Coo][coo] to create online\ndocumentation. Coo is a fork of the Jekyll theme [Chirpy][chirpy] with some\nmodifications to make it easy for creating online documentation. This template\nis based on the [Chirpy starter][chirpyStarter] template. You might find the\n[Chirpy documentation][chirpyDoc] useful to help you get started on Chirpy.\n\n\u003c!--=========================================================================--\u003e\n\n## Prerequisites\n\nThe Jekyll project has [detailed instruction][jekyllInstall] on how to setup\nJekyll and Ruby. [Git][git] is required as part of your development environment.\nYou might find [GitHub Desktop][githubDesktop] (or its [Linux\nversion][githubDesktopLinux]) to be a friendly graphical interface to Git and\nGitHub.\n\n\u003c!--=========================================================================--\u003e\n\n## Installation\n\n\u003c!--=========================================================================--\u003e\n\n### Ruby and Jekyll\n\nSign into GitHub and navigate to the template [home page][tekyll]. Click on\n\u003ckbd\u003eUse this template\u003c/kbd\u003e, then click on \u003ckbd\u003eCreate a new repository\u003c/kbd\u003e\nto create a repository based on the template. Use Git or GitHub Desktop to clone\nyour newly created repository to your local machine. At the top-level directory\nof the repository, run the command:\n\n```sh\n$ bundle\n```\n\nThe above assumes root access. Without root access, you would not be able to\ninstall Ruby gems in the system-wide directory. That is OK. Use the commands\nbelow to install all required gems under the top-level directory of the\nrepository.\n\n```sh\n$ bundle config set --local path 'vendor/bundle'\n$ bundle install\n```\n\nThe above commands would setup the Ruby and Jekyll environment for your\nrepository.\n\n\u003c!--=========================================================================--\u003e\n\n### Make\n\nThe software [Make][make] is recommended, but not required, to automate the\nbuilding of your site. Under a Linux environment, you might want to install [GNU\nMake][gnuMake]. On Windows, install Make as part of the [Cygwin][cygwin]\nenvironment.\n\nFeel free to use a build automation utility of your choice.\n\n\u003c!--=========================================================================--\u003e\n\n### npm (optional)\n\nThe package you want is [Prettier][prettier], which can automatically indent and\nformat Markdown files. Feel free to use another tool to lint/format/indent the\nMarkdown files in your project. Run the following command to install all node\npackages required by this template:\n\n```sh\n$ npm update\n```\n\n\u003c!--=========================================================================--\u003e\n\n## Usage\n\nSee the [website of the template][tekyllSite]. You might also find the\ndocumentation of the [Chirpy template][chirpyDoc] useful.\n\n\u003c!--=========================================================================--\u003e\n\n### Configuration\n\n\u003c!--=========================================================================--\u003e\n\nSee the file [`_config.yml`][config].\n\n\u003c!--=========================================================================--\u003e\n\n### Home page\n\nAt the top-level directory of your repository, create a file called `index.html`\nif it does yet exist. This is the first page that shows up when someone visits\nyour site. See the [index page][tekyllIndex] of tekyll for an example.\n\n\u003c!--=========================================================================--\u003e\n\n### Contents\n\n\u003c!--=========================================================================--\u003e\n\n#### Sections or chapters\n\nTo start writing contents for your site, create a directory named `doc/` (if it\ndoes not yet exist) at the top-level directory of your repository. All textual\ncontents for your document should be placed under the directory `doc/`. Each\nsection or chapter of your entire document should be a separate Markdown file.\nRefer to the directory [`doc/`][tekyllDoc] of tekyll for sample contents.\n\n\u003c!--=========================================================================--\u003e\n\n#### Summary\n\nYou also need to create a YAML file called `_data/summary.yml` (if it does not\nyet exist). Note that the summary must be located under the directory `_data/`.\nThe summary file shows the structure of your entire document. In particular:\n\n-   The summary file shows the location of each section or chapter of your\n    document. Recall that each section or chapter should be a separate Markdown\n    file located under the directory `doc/`.\n-   The summary file shows the order in which each section or chapter should\n    appear when you build your site. The ordering of the section/chapter will be\n    used to generate the table of contents in the sidebar.\n\nRefer to the [summary file][summary] of tekyll for an example.\n\n\u003c!--=========================================================================--\u003e\n\n#### Images\n\nImages should be placed under `assets/img/` (the default directory used by\ntekyll) or another location of your choice. If you use a content delivery\nnetwork (CDN) for images, ensure you set the URL of the CDN in the file\n`_config.yml`. The images used by the [tekyll site][tekyllSite] are hosted by\nGitHub, as can be seen in the following lines of the configuration file shipped\nwith tekyll:\n\n```yml\n# The CDN endpoint for images.\n# Notice that once it is assigned, the URL of the CDN will be added to all\n# image (site avatar and images of each page) paths starting with '/'.\n#\n# e.g. 'https://cdn.com'\nimg_cdn: https://raw.githubusercontent.com/quacksouls/tekyll/main/assets/img/\n```\n\n\u003c!--=========================================================================--\u003e\n\n### Build\n\nFeel free to use a build automation utility of your choice. The default build\nautomation tool used by this Jekyll template (i.e. tekyll) is [Make][make]. The\ndescription below refers to the `Makefile` shipped with tekyll.\n\nThe `Makefile` controls all aspects of the build process. Refer to the\n[`Makefile`][makefile] of tekyll for an example. The following explains how the\n`Makefile` of tekyll works. Note that the `Makefile` uses scripts under the\ndirectory `util/`.\n\n-   `build` -- This builds a local copy of your entire site. Use the command:\n\n    ```sh\n    $ make build\n    ```\n\n    to build your local copy.\n\n-   `clean` -- Cleanup various junk files. Use the command:\n\n    ```sh\n    $ make clean\n    ```\n\n    to perform the cleanup.\n\n-   `pretty` -- Use [Prettier][prettier] to automatically format and indent\n    Markdown files. Use the command:\n\n    ```sh\n    $ make pretty\n    ```\n\n    to run Prettier on the Markdown files under `doc/`.\n\n-   `view` -- Useful for viewing a draft of your site on your local machine.\n    This builds a local copy of your entire site. It also starts a local web\n    server to allow you to view your site on your local machine. Use the\n    command:\n\n    ```sh\n    $ make view\n    ```\n\n    to build a local copy of your site and start a local server. Open a web\n    browser and navigate to the address `http://127.0.0.1:4000` to view your\n    site.\n\n\u003c!--=========================================================================--\u003e\n\n## License\n\nThis work is covered by the MIT license. It is based on the Chirpy template by:\n\nCopyright (c) 2021 [Cotes Chung][CotesChung]\n\nModification by:\n\nCopyright (c) 2023 [Duck McSouls][quack]\n\n\u003c!--=========================================================================--\u003e\n\n[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy\n[chirpyDoc]: https://chirpy.cotes.page\n[chirpyStarter]: https://github.com/cotes2020/chirpy-starter\n[config]: ./_config.yml\n[coo]: https://github.com/quacksouls/jekyll-theme-coo\n[CotesChung]: https://github.com/cotes2020\n[cygwin]: https://cygwin.com\n[git]: https://git-scm.com\n[githubDesktop]: https://desktop.github.com\n[githubDesktopLinux]: https://github.com/shiftkey/desktop\n[gnuMake]: https://www.gnu.org/software/make/\n[jekyllInstall]: https://jekyllrb.com/docs/installation/\n[make]: https://en.wikipedia.org/wiki/Make_(software)\n[makefile]: https://github.com/quacksouls/tekyll/blob/main/Makefile\n[prettier]: https://prettier.io\n[quack]: https://github.com/quacksouls\n[summary]: https://github.com/quacksouls/tekyll/blob/main/_data/summary.yml\n[tekyll]: https://github.com/quacksouls/tekyll\n[tekyllDoc]: https://github.com/quacksouls/tekyll/tree/main/doc\n[tekyllIndex]: https://github.com/quacksouls/tekyll/blob/main/index.html\n[tekyllSite]: https://tekyllcoo.github.io\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquacksouls%2Ftekyll","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquacksouls%2Ftekyll","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquacksouls%2Ftekyll/lists"}