From 2c54317ba0b247d2b6ec817cbcb4dc53cf174f90 Mon Sep 17 00:00:00 2001 From: Zach Berwaldt Date: Mon, 23 Oct 2023 20:50:52 -0400 Subject: add docs, modify ignorefile --- .gitignore | 1 - docs/blackbear-theme.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 docs/blackbear-theme.md diff --git a/.gitignore b/.gitignore index abaa1d0..6a0ab3a 100644 --- a/.gitignore +++ b/.gitignore @@ -25,7 +25,6 @@ npm-debug.log /dist/ /src/client.config.json /styleguide/ -/docs/ /junit.xml 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 @@ +# Blackbear + +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. + +[toc] + +## Features + +## Content Types + +This section outlines the various content types that are available to the theme. + +### Guide + +### Post + +### Project + +Project is also + +#### Frontmatter Attributes + +| key | description | default value | +| --- | ----------- | ------------- | +| title | The title of the project post. | `"{{ replace .File.ContentBaseName "-" " " \| title }}"` | +| date | The date the content file was created. **Note:** not the date the content was published | `{{ .Date }}`| +| draft | Is this a draft | `true` | +| categoies | the categories that a content belongs to. | `["projects"]` | +| image | An optional image key. The key is used for opengraph meta tags by hugo | `""` | +| dontDisclaim | There is a disclaimer partial that is disabled by default for project posts. | `true` | +| 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"` | + +### Default + +This is the fall through archetypes for any content files not generated in the above archetype directories. -- cgit v1.1