{"id":17030314,"url":"https://github.com/vsoch/tw-jekyll","last_synced_at":"2025-04-12T12:12:00.326Z","repository":{"id":43082368,"uuid":"447414597","full_name":"vsoch/tw-jekyll","owner":"vsoch","description":"A jekyll-ized documentation theme using tailwind.css based on Fly.io's theme","archived":false,"fork":false,"pushed_at":"2022-03-19T19:07:07.000Z","size":1994,"stargazers_count":31,"open_issues_count":2,"forks_count":15,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-26T06:51:12.654Z","etag":null,"topics":["docs-theme","github-pages","jekyll","rseng"],"latest_commit_sha":null,"homepage":"https://vsoch.github.io/tw-jekyll/","language":"HTML","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/vsoch.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}},"created_at":"2022-01-13T00:39:54.000Z","updated_at":"2025-01-14T08:55:23.000Z","dependencies_parsed_at":"2022-08-12T10:11:39.939Z","dependency_job_id":null,"html_url":"https://github.com/vsoch/tw-jekyll","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/vsoch%2Ftw-jekyll","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsoch%2Ftw-jekyll/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsoch%2Ftw-jekyll/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsoch%2Ftw-jekyll/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vsoch","download_url":"https://codeload.github.com/vsoch/tw-jekyll/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248565077,"owners_count":21125417,"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":["docs-theme","github-pages","jekyll","rseng"],"created_at":"2024-10-14T08:06:05.667Z","updated_at":"2025-04-12T12:12:00.306Z","avatar_url":"https://github.com/vsoch.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tailwind (tw) Jekyll\n\n![assets/img/tw-jekyll.png](assets/img/tw-jekyll.png)\n\n⭐️ [Documentation Demo](https://vsoch.github.io/tw-jekyll/) ⭐️\n\nThis is a [starter template](https://vsoch.github.com/tw-jekyll/) for a Tailwind jekyll theme, based\non [these docs](https://github.com/superfly/docs) that are based on [Tailwind css](https://tailwindcss.com/docs/installation),\nhowever everything has been modified to work on GitHub pages (using Jekyll). If you don't need\nnative deployment on GitHub pages, then please consider checking out Tailwind. \nThe original [Apache License](LICENSE) is included. I (@vsoch) have extended it to include:\n\n- includes for callouts and badges\n- rainbow buttons\n- colored tags (with a tags page) for posts and articles\n- GitHub interaction buttons to edit, open an issue, or ask a question\n- customization of colors and minimal style\n- CircleCI preview\n\nAnd let me know if you'd like to add anything else, or just open a PR and contribute! 🔥️\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/tw-jekyll.git docs\ncd docs\n```\n\n### 2. Customize\n\nTo edit configuration values, customize the [_config.yml](_config.yml).\nTo add pages, write them into the [pages](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](_data/toc.yml).\nThe top navigation is controlled by [_data/navigation.yml](_data/navigation.yml)\n\n### 3. Options\n\nMost of the configuration values in the [_config.yml](_config.yml) are self explanatory,\nand for more details, see the [getting started page](https://vsoch.github.io/tw-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**NOTE:** If the above serve command throws an error saying `require': cannot load such file -- webrick (LoadError)` try to run `bundle add webrick` to automatically add the webrick gem to your Gemfile, or manually add `gem \"webrick\"` line to the Gemfile and then run the serve command again.\n\n\n### 5. Run as a container in dev or prod\n\n#### Software Dependencies\n\nIf you want to run 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%2Fvsoch%2Ftw-jekyll","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvsoch%2Ftw-jekyll","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvsoch%2Ftw-jekyll/lists"}