📝 docs: add guide to all of tabi's features (#169)
This commit is contained in:

committed by
GitHub

parent
88cc68f4a0
commit
99b8972cf6
21
README.md
21
README.md
@@ -19,19 +19,28 @@ tabi has a perfect score on Google's Lighthouse audit:
|
||||
- [X] Dark and light themes. Defaults to the OS setting, with a switcher in the navigation bar.
|
||||
- [X] Support for [comments using giscus, utterances, Hyvor Talk, or Isso](https://welpo.github.io/tabi/blog/comments/).
|
||||
- [X] Perfect Lighthouse score (Performance, Accessibility, Best Practices and SEO).
|
||||
- [X] [KaTeX](https://katex.org/) support.
|
||||
- [X] [Integration with remote repositories](https://welpo.github.io/tabi/mastering-tabi-settings/#git-repository-integration) on GitHub, GitLab, Gitea & Codeberg for commit history and showing the site source.
|
||||
- [X] [Social media cards](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#social-media-cards).
|
||||
- [X] [KaTeX](https://katex.org/) support for mathematical notation.
|
||||
- [X] All JavaScript can be [fully disabled](https://welpo.github.io/tabi/blog/javascript/).
|
||||
- [X] [Customizable skins](https://welpo.github.io/tabi/blog/customise-tabi/).
|
||||
- [X] [Stylized feed](https://welpo.github.io/tabi/atom.xml).
|
||||
- [X] [Quick navigation buttons](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#quick-navigation-buttons).
|
||||
- [X] [Footnote backlinks](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#footnote-backlinks).
|
||||
- [X] [Copy button for code blocks](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#copy-button-on-code-blocks).
|
||||
- [X] [Custom canonical URLs](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#canonical-url).
|
||||
- [X] [Projects page](https://welpo.github.io/tabi/projects/).
|
||||
- [X] [Archive page](https://welpo.github.io/tabi/archive/).
|
||||
- [x] [Table of Contents](https://welpo.github.io/tabi/blog/toc/).
|
||||
- [x] Tags.
|
||||
- [x] Social links.
|
||||
- [X] [Customizable Table of Contents](https://welpo.github.io/tabi/blog/toc/).
|
||||
- [X] [Mail encoding](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#encoded-email) for spam protection.
|
||||
- [X] [Tags](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#tags).
|
||||
- [X] [Social links](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#social-media-icons).
|
||||
- [X] [Custom copyright notice](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#copyright).
|
||||
- [X] Responsive design.
|
||||
- [X] Code syntax highlighting.
|
||||
- [X] Code syntax highlighting with colours based on [Catppuccin](https://github.com/catppuccin/catppuccin) Frappé.
|
||||
- [X] [Customizable secure headers](https://welpo.github.io/tabi/blog/security/).
|
||||
- [X] [Custom shortcodes](https://welpo.github.io/tabi/blog/shortcodes/).
|
||||
- [X] Thorough documentation. See [Mastering tabi Settings: A Comprehensive Guide](https://welpo.github.io/tabi/blog/mastering-tabi-settings/)
|
||||
|
||||
## Quick start
|
||||
|
||||
@@ -43,7 +52,7 @@ cd tabi
|
||||
zola serve
|
||||
```
|
||||
|
||||
Open http://127.0.0.1:1111/ in the browser.
|
||||
Open http://127.0.0.1:1111 in the browser.
|
||||
|
||||
## Installation
|
||||
|
||||
|
Reference in New Issue
Block a user