diff options
| author | Zach Berwaldt <zberwaldt@tutamail.com> | 2023-10-23 20:50:52 -0400 |
|---|---|---|
| committer | Zach Berwaldt <zberwaldt@tutamail.com> | 2023-10-23 20:50:52 -0400 |
| commit | 2c54317ba0b247d2b6ec817cbcb4dc53cf174f90 (patch) | |
| tree | 954a63575f23c683f9b963fc1ffd44ea979eb8f0 | |
| parent | ae5fbeb8af153d358b4d13d7e2bdd16061ca5524 (diff) | |
add docs, modify ignorefiledocs
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | docs/blackbear-theme.md | 35 |
2 files changed, 35 insertions, 1 deletions
| @@ -25,7 +25,6 @@ npm-debug.log | |||
| 25 | /dist/ | 25 | /dist/ |
| 26 | /src/client.config.json | 26 | /src/client.config.json |
| 27 | /styleguide/ | 27 | /styleguide/ |
| 28 | /docs/ | ||
| 29 | 28 | ||
| 30 | /junit.xml | 29 | /junit.xml |
| 31 | partials/structure/stylesheet.html | 30 | partials/structure/stylesheet.html |
diff --git a/docs/blackbear-theme.md b/docs/blackbear-theme.md new file mode 100644 index 0000000..cc54729 --- /dev/null +++ b/docs/blackbear-theme.md | |||
| @@ -0,0 +1,35 @@ | |||
| 1 | # Blackbear | ||
| 2 | |||
| 3 | Blackbear is a minimal and versatile theme for hugo for personal sites. The theme uses pico.css as the css starting point, with some custom css on top of it. | ||
| 4 | |||
| 5 | [toc] | ||
| 6 | |||
| 7 | ## Features | ||
| 8 | |||
| 9 | ## Content Types | ||
| 10 | |||
| 11 | This section outlines the various content types that are available to the theme. | ||
| 12 | |||
| 13 | ### Guide | ||
| 14 | |||
| 15 | ### Post | ||
| 16 | |||
| 17 | ### Project | ||
| 18 | |||
| 19 | Project is also | ||
| 20 | |||
| 21 | #### Frontmatter Attributes | ||
| 22 | |||
| 23 | | key | description | default value | | ||
| 24 | | --- | ----------- | ------------- | | ||
| 25 | | title | The title of the project post. | `"{{ replace .File.ContentBaseName "-" " " \| title }}"` | | ||
| 26 | | date | The date the content file was created. **Note:** not the date the content was published | `{{ .Date }}`| | ||
| 27 | | draft | Is this a draft | `true` | | ||
| 28 | | categoies | the categories that a content belongs to. | `["projects"]` | | ||
| 29 | | image | An optional image key. The key is used for opengraph meta tags by hugo | `""` | | ||
| 30 | | dontDisclaim | There is a disclaimer partial that is disabled by default for project posts. | `true` | | ||
| 31 | | description | A brief description for the page. This not used in the template it is for the opengraph meta tags. | `"An informal specification for the {{ replace .File.ContentBaseName "-" " " \| title }} project"` | | ||
| 32 | |||
| 33 | ### Default | ||
| 34 | |||
| 35 | This is the fall through archetypes for any content files not generated in the above archetype directories. | ||
