setup
This commit is contained in:
57
themes/hugo-theme-monochrome/README.md
Normal file
57
themes/hugo-theme-monochrome/README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
<p align="center">
|
||||
<a href="https://kaiiiz.github.io/hugo-theme-monochrome">
|
||||
<img alt="Monochrome" src="https://github.com/kaiiiz/hugo-theme-monochrome/blob/dev/images/screenshot.png">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<h2 align="center">
|
||||
Monochrome
|
||||
</h2>
|
||||
|
||||
<p align="center">
|
||||
A fast, clean and responsive hugo theme
|
||||
</p>
|
||||
|
||||
## Demo & Documents
|
||||
|
||||
See [kaiiiz.github.io/hugo-theme-monochrome](https://kaiiiz.github.io/hugo-theme-monochrome)
|
||||
|
||||
## Features
|
||||
|
||||
1. **Clean UI with small resources.** Monochrome has clean UI design with ~5KB gzipped bundled CSS.
|
||||
|
||||
2. **Self-Contained.** Monochrome doesn't require webpack, nodejs and other dependencies to setup or edit, just hugo.
|
||||
|
||||
3. **Responsive layout.** Adapt to different viewpoint, from desktop to mobile.
|
||||
|
||||
4. **Support light/dark mode.** Low-light UI.
|
||||
|
||||
5. **Multiple layouts built-in.** Monochrome now supports 6 different layouts. See [Demo](https://kaiiiz.github.io/hugo-theme-monochrome/layouts/).
|
||||
|
||||
6. **Nested navbar and Multilingual mode.** Make good use of hugo's well-designed structure.
|
||||
|
||||
7. **Syntax Highlighting (with copy feature).** Integrate both server-side solution (Chroma, hugo built-in) and client-side solution (Prism.js, for someone who need more languages supported).
|
||||
|
||||
8. **Site Search with real-time matches highlight.** Powered by Fuse.js.
|
||||
|
||||
9. **SEO-friendly.** Easily change your author, description, keywords, open graph, twitter card meatdata.
|
||||
|
||||
10. **Support mathematical notation.** Powered by MathJax.
|
||||
|
||||
11. **Useful shortcodes.** See [Document](https://kaiiiz.github.io/hugo-theme-monochrome/shortcodes/).
|
||||
|
||||
## Installation
|
||||
|
||||
See [Setup](https://kaiiiz.github.io/hugo-theme-monochrome/setup)
|
||||
|
||||
## Configuration
|
||||
|
||||
See [Configuration](https://kaiiiz.github.io/hugo-theme-monochrome/configuration/)
|
||||
|
||||
## Acknowledgement
|
||||
|
||||
* [PrismJS/prism](https://github.com/PrismJS/prism)
|
||||
* [krisk/Fuse](https://github.com/krisk/Fuse)
|
||||
* [mathjax/MathJax](https://github.com/mathjax/MathJax)
|
||||
* [kingdido999/zooming](https://github.com/kingdido999/zooming)
|
||||
* [feathericons/feather](https://github.com/feathericons/feather)
|
||||
Reference in New Issue
Block a user