{"id":27072864,"url":"https://github.com/tinygs/tinygs.github.io","last_synced_at":"2025-04-05T23:34:01.767Z","repository":{"id":280057841,"uuid":"359314520","full_name":"tinygs/tinygs.github.io","owner":"tinygs","description":null,"archived":false,"fork":false,"pushed_at":"2021-04-19T03:26:21.000Z","size":1691,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-01T00:57:54.115Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tinygs.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":"2021-04-19T03:14:37.000Z","updated_at":"2021-04-19T03:26:23.000Z","dependencies_parsed_at":"2025-03-01T00:57:57.179Z","dependency_job_id":"44ab6b3d-cab9-45fa-a42e-38fb10becce3","html_url":"https://github.com/tinygs/tinygs.github.io","commit_stats":null,"previous_names":["tinygs/tinygs.github.io"],"tags_count":0,"template":false,"template_full_name":"vsoch/docsy-jekyll","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinygs%2Ftinygs.github.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinygs%2Ftinygs.github.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinygs%2Ftinygs.github.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinygs%2Ftinygs.github.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tinygs","download_url":"https://codeload.github.com/tinygs/tinygs.github.io/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415821,"owners_count":20935384,"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":"2025-04-05T23:34:00.964Z","updated_at":"2025-04-05T23:34:01.759Z","avatar_url":"https://github.com/tinygs.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docsy Jekyll Theme\n\n[![CircleCI](https://circleci.com/gh/vsoch/docsy-jekyll/tree/master.svg?style=svg)](https://circleci.com/gh/vsoch/docsy-jekyll/tree/master)\n\u003ca href=\"https://jekyll-themes.com/docsy-jekyll/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/featured%20on-JT-red.svg\" height=\"20\" alt=\"Jekyll Themes Shield\" \u003e\n\u003c/a\u003e\n\n![https://raw.githubusercontent.com/vsoch/docsy-jekyll/master/assets/img/docsy-jekyll.png](https://raw.githubusercontent.com/vsoch/docsy-jekyll/master/assets/img/docsy-jekyll.png)\n\nThis is a [starter template](https://vsoch.github.com/docsy-jekyll/) for a Docsy jekyll theme, based\non the Beautiful [Docsy](https://github.com/google/docsy) that renders with Hugo. This version is intended for\nnative deployment on GitHub pages. The original [Apache License](https://github.com/vsoch/docsy-jekyll/blob/master/LICENSE) is included.\n\n## Changes\n\nThe site is intended for purely documentation, so while the front page banner\nis useful for business or similar, this author (@vsoch) preferred to have\nthe main site page go directly to the Documentation view. Posts\nare still provided via a feed.\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/docsy-jekyll.git docs\ncd docs\n```\n\n### 2. Customize\n\nTo edit configuration values, customize the [_config.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_config.yml).\nTo add pages, write them into the [pages](https://github.com/vsoch/docsy-jekyll/blob/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/docsy-jekyll/blob/master/_data/toc.yml).\nThe top navigation is controlled by [_data/navigation.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_data/navigation.yml)\n\n### 3. Options\n\nMost of the configuration values in the [_config.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_config.yml) are self explanatory,\nand for more details, see the [getting started page](https://vsoch.github.io/docsy-jekyll/docs/getting-started)\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\n### 5. Run as a container in dev or prod\n\n#### Software Dependencies\n\nIf you want to run docsy jekyll via a container for development (dev) or production (prod) you can use containers. This approach requires installing [docker-ce](https://docs.docker.com/engine/install/ubuntu/) and [docker-compose](https://docs.docker.com/compose/install/). \n\n#### Customization\n\nNote that the [docker-compose.yml](docker-compose.yml) file is using the [jekyll/jekyll:3.8](https://hub.docker.com/r/jekyll/jekyll/tags) image. If you want to make your build more reproducible, you can specify a particular version for jekyll (tag). Note that at the development time of writing this documentation, the latest was tag 4.0.0,\nand it [had a bug](https://github.com/fastai/fastpages/issues/267#issuecomment-620612896) that prevented the server from deploying.\n\nIf you are deploying a container to production, you should remove the line to\nmount the bundles directory to the host in the docker-compose.yml. Change:\n\n```yaml\n    volumes: \n      - \"./:/srv/jekyll\"\n      - \"./vendor/bundle:/usr/local/bundle\"\n      # remove \"./vendor/bundle:/usr/local/bundle\" volume when deploying in production\n```\n\nto:\n\n```yaml\n    volumes: \n      - \"./:/srv/jekyll\"\n```\n\nThis additional volume is optimal for development so you can cache the bundle dependencies,\nbut should be removed for production. \n\n#### Start Container\n\nOnce your docker-compose to download the base container and bring up the server:\n\n```bash\ndocker-compose up -d\n```\n\nYou can then open your browser to [http://localhost:4000](http://localhost:4000)\nto see the server running.\n\n\u003e Node : changes `baseurl: \"\"` in _config.yml  when you are running in local and prod according to the requirement.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftinygs%2Ftinygs.github.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftinygs%2Ftinygs.github.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftinygs%2Ftinygs.github.io/lists"}