Set up a basic Jekyll theme

This commit is contained in:
Dustin J. Mitchell 2022-03-05 17:41:44 -05:00 committed by Tomas Babej
parent e2ef45a06e
commit 377f517154
3 changed files with 50 additions and 0 deletions

5
docs/_config.yml Normal file
View file

@ -0,0 +1,5 @@
theme: jekyll-theme-cayman
description: Development Docs
show_downloads: false
github:
is_project_page: false

View file

@ -0,0 +1,8 @@
---
---
@import "{{ site.theme }}";
.page-header {
padding: 1rem 2rem;
}

37
docs/index.md Normal file
View file

@ -0,0 +1,37 @@
## Welcome to GitHub Pages
You can use the [editor on GitHub](https://github.com/djmitche/taskwarrior/edit/dev-docs/docs/index.md) to maintain and preview the content for your website in Markdown files.
Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files.
### Markdown
Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
```markdown
Syntax highlighted code block
# Header 1
## Header 2
### Header 3
- Bulleted
- List
1. Numbered
2. List
**Bold** and _Italic_ and `Code` text
[Link](url) and ![Image](src)
```
For more details see [Basic writing and formatting syntax](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
### Jekyll Themes
Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/djmitche/taskwarrior/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
### Support or Contact
Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and well help you sort it out.