{"id":15450337,"url":"https://github.com/conedevelopment/sprucecss-eleventy-documentation-template","last_synced_at":"2025-04-22T15:24:58.358Z","repository":{"id":168624974,"uuid":"589686586","full_name":"conedevelopment/sprucecss-eleventy-documentation-template","owner":"conedevelopment","description":"A simple documentation template made with Eleventy and Spruce CSS.","archived":false,"fork":false,"pushed_at":"2024-08-01T15:16:32.000Z","size":2509,"stargazers_count":61,"open_issues_count":1,"forks_count":14,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-29T16:23:14.081Z","etag":null,"topics":["11ty","11ty-template","documentation","documentation-site","documentation-template","documentation-theme","eleventy","eleventy-template","scss","sprucecss","spruceui"],"latest_commit_sha":null,"homepage":"https://eleventy-documentation.sprucecss.com","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/conedevelopment.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"github":["iamgergo","adamlaki"]}},"created_at":"2023-01-16T17:42:29.000Z","updated_at":"2025-03-15T01:04:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"3d7e898c-c980-4383-9bd8-5fba8bd1c42b","html_url":"https://github.com/conedevelopment/sprucecss-eleventy-documentation-template","commit_stats":{"total_commits":135,"total_committers":1,"mean_commits":135.0,"dds":0.0,"last_synced_commit":"aa8eee2a92b71e5817abb3ecd4c95b7e7999c840"},"previous_names":["conedevelopment/sprucecss-eleventy-documentation-template"],"tags_count":8,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conedevelopment%2Fsprucecss-eleventy-documentation-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conedevelopment%2Fsprucecss-eleventy-documentation-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conedevelopment%2Fsprucecss-eleventy-documentation-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conedevelopment%2Fsprucecss-eleventy-documentation-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/conedevelopment","download_url":"https://codeload.github.com/conedevelopment/sprucecss-eleventy-documentation-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250265779,"owners_count":21402167,"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":["11ty","11ty-template","documentation","documentation-site","documentation-template","documentation-theme","eleventy","eleventy-template","scss","sprucecss","spruceui"],"created_at":"2024-10-01T21:04:36.424Z","updated_at":"2025-04-22T15:24:58.301Z","avatar_url":"https://github.com/conedevelopment.png","language":"SCSS","funding_links":["https://github.com/sponsors/iamgergo","https://github.com/sponsors/adamlaki"],"categories":[],"sub_categories":[],"readme":"\u003cp\u003e\n    \u003ca href=\"https://sprucecss.com/\"\u003e\n        \u003cbr\u003e\n        \u003cpicture\u003e\n            \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"./.github/spruce-logo-dark.svg\"\u003e\n            \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"./.github/spruce-logo-light.svg\"\u003e\n            \u003cimg alt=\"Spruce CSS\" width=\"140\" src=\"./.github/spruce-logo-dark.svg\"\u003e\n        \u003c/picture\u003e\n        \u003cbr\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n**Welcome to the official documentation of **Spruce Docs** Elventy theme. A small template you can use to document any of your projects.**\n\n\u003cbr\u003e\n\n![The preview image of the theme.](./.github/spruce-docs-preview-mockup-2.png)\n\n\n[![Github release](https://img.shields.io/github/v/release/conedevelopment/sprucecss-eleventy-documentation-template?color=2350f6\u0026logo=github\u0026logoColor=white\u0026style=for-the-badge)](https://github.com/conedevelopment/sprucecss-eleventy-documentation-template/releases/latest)\n[![License](https://img.shields.io/badge/license-MIT-2350f6?style=for-the-badge)](https://github.com/conedevelopment/sprucecss-eleventy-documentation-template/blob/main/LICENSE)\n\nA documentation template is always helpful. There are a lot of solutions to make one; we wanted to create our self-hosted version based on our favorite static site generator [Eleventy](https://www.11ty.dev/).\n\nBy structure, it is simple, with two levels and additional custom templates like [FAQ]([/faq/](https://eleventy-documentation.sprucecss.com/faq/)) and [Changelog]([/changelog/](https://eleventy-documentation.sprucecss.com/changelog/)).\n\n## Spruce CSS\n\nThe template is built on [Spruce CSS](https://sprucecss.com/), a small and customizable CSS framework. The main benefit of this is that you can use the Spruce UI components with dark mode and RTL support.\n\n## Features\n\n- Breadcrumb navigation built on [11ty Navigation Plugin](https://www.11ty.dev/docs/plugins/navigation/).\n- HTML minification in production mode.\n- Anchor headings.\n- Table of Content.\n- FAQ template.\n- Changelog template.\n- Static search integration with [pagefind](https://pagefind.app/).\n- Code highlighting.\n- RTL support.\n- Dark theme mode.\n- [svgIcon](https://github.com/conedevelopment/sprucecss-eleventy-documentation-template/blob/main/src/shortcodes/svg-icon.js) shortcode: render any SVG icon inline and add optional classes.\n- [markdownRenderer](https://github.com/conedevelopment/sprucecss-eleventy-documentation-template/blob/main/src/shortcodes/markdown-render.js): render any string (markdown) into HTML.\n\n## Setup\n\n1. **Clone the repository.**\n\n2. **Install the dependencies.**\n\n    In the `package.json` file, you will find all of the dependencies (and scripts) to install them using the following command:\n\n    ```shell\n    npm install\n    ```\n\n3. **Run the development mode**\n\n    To run the development mode, use the `npm script`.   This script will also watch for changes.\n\n    ```shell\n    npm start\n    ```\n\n4. **Run the production mode**\n\n    Before you go live, you should use the production script to compress the Sass files.\n\n    ```shell\n    npm run prod\n    ```\n\nYou can find some more npm scripts in the [package.json](https://github.com/conedevelopment/sprucecss-eleventy-documentation-template/blob/main/package.json) that can be helpful.\n\n## Content Managment\n\nAdding content to the template is easy as almost everything is in Eleventy.\n\n### The Basic Structure\n\nOur base folder for the documentation pages is the `posts` folder. You must follow the folder structure, which means the `category` here. If you create a folder, you must make a list page with the same name as the folder. You must also create another `posts` folder under the `category` folder where your posts go. You must create the `posts.json` file that will parameter your `layout` and `permalink` values.\n\n### Eleventy Navigation\n\nThe theme utilizes the [Eleventy Navigation plugin](https://www.11ty.dev/docs/plugins/navigation/), so you must explicitly set up the hierarchy. This is needed for the automatic sidebar navigation, the navigation order, and breadcrumb generation.\n\n### Other Pages\n\nTo create simple pages, make a file directly under the `src` folder and configure it with the available front matter.\n\n## Structure\n\n```html\nspruecss-eleventy-documentation-template/\n├─ node_modules/\n├─ dist/\n├─ src/\n│  ├─ _data/\n│  ├─ _includes/\n│  ├─ css/\n│  ├─ filters/\n│  ├─ font/\n│  ├─ img/\n│  ├─ js/\n│  ├─ posts/\n│  ├─ scss/\n│  ├─ shortcodes/\n│  ├─ transforms/\n│  ├─ changelog.md\n│  ├─ faq.md\n│  ├─ index.md\n├─ .eleventy.js\n├─ package.json\n├─ README.md\n├─ ...\n\n```\n\n- **_data**: Some global data, like the name of your site and helpers like the active navigation element or current year.\n- **__includes**: All of the layout and partial templates.\n- **css**: The compiled CSS.\n- **filters**: The additional filters that you can use.\n- **font**: The custom fonts.\n- **img**: The static image files.\n- **posts**: The markdown contents.\n- **scss**: The Sass files.\n- **shortcodes**: The available shortcodes.\n- **transforms**: The transformations.\n\n\u003cbr\u003e\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/b7560c95-7035-491b-8c3f-94c43bea761e/deploy-status)](https://app.netlify.com/sites/sprucecss-eleventy-documentation/deploys)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconedevelopment%2Fsprucecss-eleventy-documentation-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconedevelopment%2Fsprucecss-eleventy-documentation-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconedevelopment%2Fsprucecss-eleventy-documentation-template/lists"}