Skip to content

Commit 6cea48e

Browse files
committed
chore: docs and readme
1 parent f0c6e71 commit 6cea48e

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,27 @@
1-
# Theme Name
1+
# Rusty Typewriter
22

3-
A rusty hugo theme
3+
Rusty-Typewriter is a theme for Hugo sites made by [math-queiroz](https://github.com/math-queiroz). It's intended to be simple and used for blogs, being mostly inspired by the current [Zen Browser's website](https://zen-browser.app/) in style and other Hugo themes in functionality. It was initially intended for personal use, but made public for whomever find it worth using.
44

5+
![./docs/preview.png]
6+
7+
## Features
8+
9+
- Dark/Light Mode
10+
- Search
11+
- Side Pane
12+
- Customization Flgas
13+
- CSS Styling
14+
- I18n support
15+
- Responsive layout
16+
17+
## Using the theme
18+
19+
Info on how to use the theme can be found [here](https://math-queiroz.github.io/rusty-typewriter/posts/getting-started)!
20+
21+
## Documentation
22+
23+
The documentation for theme features can be found in the [example page](https://math-queiroz.github.io/rusty-typewriter).
24+
25+
## Contributing
26+
27+
Contributing guidelines soon, for now consider leaving feedback/ideas in discussions, or reporting bugs in issues ;)

docs/preview.png

158 KB
Loading

0 commit comments

Comments
 (0)