add some docs

This commit is contained in:
Henri Dickson 2024-06-06 16:27:48 -04:00
parent ad0c704422
commit 612d807e7d
5 changed files with 11 additions and 6 deletions

View file

@ -1,4 +1,4 @@
NeoDB is an open-source software and global community platform. It allows users to manage and explore collections, reviews, and ratings for various cultural products, including books, movies, music, podcasts, games, and performances. Additionally, users can share their collections, publish microblogs, and engage with others in the Fediverse. NeoDB combines the functionalities of platforms such as Mastodon, Goodreads, Letterboxd, RateYourMusic, and Podchaser, among others.
NeoDB is an open-source software and global community platform [since 2021](story.md). It allows users to manage and explore collections, reviews, and ratings for various cultural products, including books, movies, music, podcasts, games, and performances. Additionally, users can share their collections, publish microblogs, and engage with others in the Fediverse. NeoDB integrates the functionalities of platforms like Goodreads, Letterboxd, RateYourMusic, and Podchaser, among others. It also supports self-hosting and interconnection through containerized deployment and the ActivityPub protocol.
This project is licensed under AGPLv3.

View file

@ -1,8 +1,9 @@
:root {
--md-primary-fg-color: #0172ad;
/* --md-primary-fg-color--light: #0172ad;*/
/* --md-primary-fg-color--dark: #01aaff;*/
--md-primary-fg-color--light: #0172ad;
--md-primary-fg-color--dark: #0172ad;
--md-accent-fg-color: #01aaff;
/* --md-accent-fg-color--light: #01aaff;*/
--md-accent-fg-color--light: #01aaff;
--md-accent-fg-color--dark: #01aaff;
font-family:system-ui, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, Helvetica, Arial, "Helvetica Neue", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
}

View file

@ -1,2 +1,5 @@
{% extends "base.html" %}
{% block extrahead %}<link rel="me" href="https://mastodon.online/@neodb">{% endblock %}
{% block extrahead %}
<link rel="me" href="https://mastodon.online/@neodb">
<link rel="me" href="https://mastodon.social/@neodb">
{% endblock %}

View file

@ -1,5 +1,5 @@
Upgrade
-------
=======
Check the [release notes](https://github.com/neodb-social/neodb/releases), update `compose.yml` and `.env` as instructed.

View file

@ -11,6 +11,7 @@ nav:
- configuration.md
- troubleshooting.md
- development.md
- 'Our Story': story.md
theme:
logo: assets/logo.svg
name: material