Skip to content

Commit 318d56c

Browse files
committed
Content
1 parent f420c73 commit 318d56c

File tree

21 files changed

+278
-134
lines changed

21 files changed

+278
-134
lines changed

.github/spruce-logo-dark.svg

Lines changed: 20 additions & 0 deletions
Loading

.github/spruce-logo-light.svg

Lines changed: 20 additions & 0 deletions
Loading

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Spruce CSS Eleventy Documentation Template
2+
3+
## v1.0.0 (2023-05-23)
4+
5+
Initial release

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Cone Development
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<p>
2+
<a href="https://sprucecss.com/#gh-light-mode-only">
3+
<br/>
4+
<img src="./.github/spruce-logo-dark.svg" alt="Spruce CSS" width="160">
5+
<br/>
6+
</a>
7+
<a href="https://sprucecss.com/#gh-dark-mode-only">
8+
<br/>
9+
<img src="./.github/spruce-logo-light.svg" alt="Spruce CSS" width="160">
10+
<br/>
11+
</a>
12+
</p>
13+
14+
**Do you work on a project that requires a documentation? This theme is for you. It's a simple, clean and responsive theme for Eleventy.**
15+
16+
## Features
17+
18+
- [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.
19+
- [markdownRenderer](https://github.com/conedevelopment/sprucecss-eleventy-documentation-template/blob/main/src/shortcodes/markdown-render.js): render any string (markdown) into HTML.
20+
- Breadcrumb navigation built on [11ty Navigation Plugin](https://www.11ty.dev/docs/plugins/navigation/).
21+
- HTML minification in production mode.
22+
- Anchor headings.
23+
- Table of Content.
24+
- FAQ template.
25+
- Changelog template.
26+
- Static search integration with [pagefind](https://pagefind.app/).
27+
- Code highlighting.
28+
- RTL support.
29+
- Dark mode.

0 commit comments

Comments
 (0)