Skip to content

Commit 902e7ee

Browse files
committed
Add badges to readme
1 parent 721703d commit 902e7ee

1 file changed

Lines changed: 21 additions & 2 deletions

File tree

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
1-
![logo](/backend/icon.svg)
2-
31
# Gnotus
42

3+
![logo](/backend/icon.svg)
4+
55
Gnotus is an open-source, permissively licensed, and self-hosted knowledge-base software
66
for both public and internal documentation.
77

8+
![License](https://img.shields.io/github/license/merlinz01/gnotus)
9+
![Contributors](https://img.shields.io/github/contributors/merlinz01/gnotus)
10+
![Repo Size](https://img.shields.io/github/repo-size/merlinz01/gnotus)
11+
12+
![CI Build](https://img.shields.io/github/actions/workflow/status/merlinz01/gnotus/build.yml?branch=main)
13+
![GitHub Issues](https://img.shields.io/github/issues/merlinz01/gnotus)
14+
![GitHub Closed Pull Requests](https://img.shields.io/github/issues-pr-closed/merlinz01/gnotus)
15+
![Last Commit](https://img.shields.io/github/last-commit/merlinz01/gnotus)
16+
17+
![Docker Pulls](https://img.shields.io/docker/pulls/merlinz01/gnotus-frontend)
18+
![GitHub Stars](https://img.shields.io/github/stars/merlinz01/gnotus?style=flat)
19+
![GitHub Forks](https://img.shields.io/github/forks/merlinz01/gnotus?style=flat)
20+
821
## Table of Contents
922

1023
- [Features](#features)
@@ -20,6 +33,8 @@ for both public and internal documentation.
2033
- Markdown document format
2134
- Upload management for images and other files
2235
- Optimized for search engine indexing
36+
- Supports both light and dark mode
37+
- Responsive design for mobile, desktop, and print
2338
- Customizable site branding with colors and logo
2439
- Automatic table of contents generation
2540
- Document history with the ability to revert to previous versions
@@ -228,9 +243,11 @@ You can also set up the development environment without Docker Compose, but this
228243
```
229244

230245
1. **Run the backend server**
246+
231247
```bash
232248
GNOTUS_CONFIG_FILE=config-dev.yml fastapi dev
233249
```
250+
234251
The API will be available at `http://localhost:8000` and will auto-reload when you modify backend code.
235252

236253
#### Frontend Setup
@@ -243,9 +260,11 @@ You can also set up the development environment without Docker Compose, but this
243260
```
244261

245262
2. **Run the frontend development server**
263+
246264
```bash
247265
npm run dev
248266
```
267+
249268
The app will be available at `http://localhost:5173` and will hot-reload when you modify frontend code.
250269

251270
## License

0 commit comments

Comments
 (0)