diff --git a/docs/apps.md b/docs/apps.md index 68dbabb9..e5175a28 100644 --- a/docs/apps.md +++ b/docs/apps.md @@ -1,14 +1,15 @@ # Apps +NeoDB web version will provide the most features and experience, while some third-party apps are also available below. ## Apps for NeoDB A few apps for NeoDB are being actively developed: - - [Piecelet](https://piecelet.app) by `@piecelet@mastodon.social` - [App Store](https://apps.apple.com/app/piecelet-for-neodb/id6739444863) / [Source Code]() + - [Piecelet](https://piecelet.app) by `@piecelet@mastodon.social` - [App Store](https://apps.apple.com/app/piecelet-for-neodb/id6739444863) / [Source Code](https://github.com/lcandy2/neodb-app) - [Chihu](https://chihu.app) by `@chihu@mastodon.social` - [Test Flight](https://testflight.apple.com/join/WmbnP9Vx) -These apps are not affiliated with NeoDB, but they are being developed with the support of this community. If you are also developing an app for NeoDB, please let us know so we can add it to the list. +These apps are not affiliated with NeoDB, but they are being developed with the support of this community. If you are also developing an app for NeoDB, and wish to share that with the community, please [edit this file](https://github.com/neodb-social/neodb/edit/main/docs/apps.md) and submit a pull request. ## Mastodon apps diff --git a/docs/assets/servers.json b/docs/assets/servers.json deleted file mode 100644 index f7ad0856..00000000 --- a/docs/assets/servers.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "version": "1.0", - "servers": [ - { - "name": "NeoDB", - "host": "neodb.social", - "labels": [ - "flagship" - ], - "languages": [ - "zh", - "en" - ] - }, - { - "name": "Eggplant", - "host": "eggplant.place", - "labels": [ - "beta" - ], - "languages": [ - "en" - ] - }, - { - "name": "ReviewDB", - "host": "neodb.social", - "languages": [ - "en" - ] - }, - { - "name": "Minreol", - "host": "minreol.dk", - "languages": [ - "da" - ] - } - ] -} diff --git a/docs/servers.json b/docs/servers.json new file mode 100644 index 00000000..08290ce4 --- /dev/null +++ b/docs/servers.json @@ -0,0 +1,67 @@ +{ + "version": "1.0", + "servers": [ + { + "host": "neodb.social", + "description": "Flagship instance, managed by NeoDB developers.", + "label": [ + "flagship" + ], + "language": [ + "zh", + "en" + ] + }, + { + "name": "NeoDB experimental", + "host": "eggplant.place", + "description": "Instance running development version of NeoDB software, which may have newer features and occationally bugs, managed by NeoDB developers.", + "label": [ + "beta" + ], + "language": [ + "en" + ] + }, + { + "name": "ReviewDB", + "host": "neodb.social", + "admin": [ + "@shlee@aus.social" + ], + "language": [ + "en" + ] + }, + { + "name": "Minreol", + "host": "minreol.dk", + "admin": [ + "@pmakholm@norrebro.space" + ], + "language": [ + "da" + ] + }, + { + "name": "CasDB", + "host": "db.casually.cat", + "admin": [ + "@casuallynoted@casually.cat" + ], + "language": [ + "en" + ] + }, + { + "name": "KevGa-NeoDB", + "host": "neodb.kevga.de", + "admin": [ + "@lorker@mastodon.kevga.de" + ], + "language": [ + "de" + ] + } + ] +} diff --git a/docs/servers.md b/docs/servers.md index 98825963..82170f43 100644 --- a/docs/servers.md +++ b/docs/servers.md @@ -1,25 +1,20 @@ # Servers -## Public instances hosted by NeoDB developers +## Community instances - - [NeoDB.social](https://neodb.social) - the flagship instance - - [NeoDB experimental](https://eggplant.place) - an instance running the development version of NeoDB software, which may include more features and potential bugs +NeoDB is not a single website. To use it, you need to sign up on an instance, that lets you connect with other people using NeoDB across Fediverse and Bluesky. +{servers} -## Public instances hosted by volunteers +JSON version of this list is also available [here](servers.json). If you are hosting a public instance of NeoDB and wish to share that with the community, please [edit this file](https://github.com/neodb-social/neodb/edit/main/docs/servers.json) and submit a pull request. - - [ReviewDB](https://reviewdb.app) - admin: `@shlee@aus.social` - - [MinReol](https://minreol.dk) - admin: `@pmakholm@norrebro.space` - - [CasDB](https://db.casually.cat) - admin: `@casuallynoted@casually.cat` - - [KevGa-NeoDB](https://neodb.kevga.de) - admin: `@Lorker@mastodon.kevga.de` - -If you are also hosting a public instance of NeoDB, please let us know so we can add it to the list above. +To host your own instance of NeoDB, see [installation guide](install.md). ## Public relay hosted by NeoDB developers - - `relay.neodb.net` - NeoDB servers may connect to this relay to send and receive public posts, this is to help share items, ratings and reviews in the network, more on this in [configuration doc](configuration.md). + - `relay.neodb.net` - NeoDB instances may connect to this relay to send and receive public posts, this is to help share items, ratings and reviews in the network, more on this in [configuration doc](configuration.md). ## Honorable mention diff --git a/mkdocs.yml b/mkdocs.yml index f1e01b0e..3083d6bf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,3 +51,5 @@ markdown_extensions: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format +hooks: + - mkdocs_hook.py diff --git a/mkdocs_hook.py b/mkdocs_hook.py new file mode 100644 index 00000000..234d08b6 --- /dev/null +++ b/mkdocs_hook.py @@ -0,0 +1,26 @@ +import json + + +def on_page_markdown(markdown, page, config, **kwargs): + if page.url == "servers/": + with open(config.docs_dir + "/servers.json") as f: + servers = json.load(f) + m = "" + for s in servers["servers"]: + host = s["host"] + name = s.get("name", host) + admin = s.get("admin", []) + label = s.get("label", []) + language = s.get("language", []) + description = s.get("description", "") + m += f" - **[{name}](https://{host})**" + if label: + m += f" {' '.join([f'`{a}`' for a in label])}" + if language: + m += f" {' '.join([f'`{a}`' for a in language])}" + if description: + m += f" \n {description}" + if admin: + m += f" \n admin: {', '.join([f'`{a}`' for a in admin])}" + m += "\n" + return markdown.replace("{servers}", m) diff --git a/neodb-takahe b/neodb-takahe index f084d7f5..90183c93 160000 --- a/neodb-takahe +++ b/neodb-takahe @@ -1 +1 @@ -Subproject commit f084d7f5635721958c5f1bd59421d02d3e24f614 +Subproject commit 90183c931a48f9067dbace7650fd6b2b5c9015dc