From 617c031603fa14d5aeac60adb8cdf27e74d29b60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?nicole=20miko=C5=82ajczyk?= Date: Sat, 7 Mar 2026 20:21:36 +0100 Subject: [PATCH] update docs for new website MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nicole mikołajczyk --- docs/building/nicolium.md | 6 ++++++ docs/code-of-conduct.md | 6 ------ docs/contributing/code-of-conduct.mdx | 9 +++++++++ docs/contributing/nicolium.md | 13 +++++++++---- docs/contributing/pl-api.md | 6 ++++++ docs/index.md | 3 --- docs/index.mdx | 8 ++++++++ docs/installing/iceshrimp.md | 6 ++++++ docs/installing/mitra.md | 6 ++++++ docs/installing/pleroma-akkoma.md | 6 ++++++ docs/installing/standalone.md | 6 ++++++ 11 files changed, 62 insertions(+), 13 deletions(-) delete mode 100644 docs/code-of-conduct.md create mode 100644 docs/contributing/code-of-conduct.mdx delete mode 100644 docs/index.md create mode 100644 docs/index.mdx diff --git a/docs/building/nicolium.md b/docs/building/nicolium.md index edb4d137d..b27a9d1d1 100644 --- a/docs/building/nicolium.md +++ b/docs/building/nicolium.md @@ -1,3 +1,9 @@ +--- +title: Building Nicolium +section: Building +order: 10 +--- + # Building Nicolium Building Nicolium requires [Node.js](https://nodejs.org/) and [pnpm](https://pnpm.io/) package manager to be installed. Since Node v16.13, Node.js comes with `corepack` pre-installed, which can be used to manage package managers like `pnpm`. diff --git a/docs/code-of-conduct.md b/docs/code-of-conduct.md deleted file mode 100644 index 601bf81f8..000000000 --- a/docs/code-of-conduct.md +++ /dev/null @@ -1,6 +0,0 @@ -# Code of Conduct - -{% - include "../CODE_OF_CONDUCT.md" - start='\n\n' -%} diff --git a/docs/contributing/code-of-conduct.mdx b/docs/contributing/code-of-conduct.mdx new file mode 100644 index 000000000..b2b587292 --- /dev/null +++ b/docs/contributing/code-of-conduct.mdx @@ -0,0 +1,9 @@ +--- +title: Code of Conduct +section: Contributing +order: 22 +--- + +import CodeOfConduct from '../../CODE_OF_CONDUCT.md'; + + diff --git a/docs/contributing/nicolium.md b/docs/contributing/nicolium.md index 28a089fd8..b07a4f7bc 100644 --- a/docs/contributing/nicolium.md +++ b/docs/contributing/nicolium.md @@ -1,3 +1,9 @@ +--- +title: Contributing to Nicolium +section: Contributing +order: 20 +--- + # Contributing to Nicolium The page intends to provide a technical overview of the Nicolium codebase and guidelines for potential contributors. @@ -6,8 +12,7 @@ The page intends to provide a technical overview of the Nicolium codebase and gu Nicolium is a single page application built using the [React](https://react.dev/) framework. It uses [TypeScript](https://www.typescriptlang.org/) as the programming language and [Vite](https://vitejs.dev/) as the build tool. Routing is handled by [TanStack Router](https://tanstack.com/router/latest). Client state management is done using [Zustand](https://zustand-demo.pmnd.rs/) and server state management using [TanStack Query](https://tanstack.com/query/latest). -!!! note - Important parts of Nicolium are currently being refactored to use a different set of libraries. You can find occurrences of tools being phased out, like Redux or TailwindCSS. Larger contributions should wait until the refactor is complete. +> **Note:** Important parts of Nicolium are currently being refactored to use a different set of libraries. You can find occurrences of tools being phased out, like Redux or TailwindCSS. Larger contributions should wait until the refactor is complete. Nicolium also uses `pl-api` library for interacting with the Mastodon-compatible backends. The goal of `pl-api` is to provide a unified, type-safe API for multiple backends extending Mastodon API in incompatible ways. You can find the `pl-api` source code in the `packages/pl-api` directory of the Nicolium repository. @@ -36,8 +41,8 @@ pnpm -F nicolium dev The server supports hot module reloading, so any changes you make to the source code will be reflected in the browser automatically. -!!! tip - You can install the [React Developer Tools](https://react.dev/learn/react-developer-tools) browser extension to inspect components, their props and state. It might help you understand the application better and identify performance problems. It is available for [Firefox](https://addons.mozilla.org/en-US/firefox/addon/react-devtools/), [Chrome](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) (and compatible Chromium-based browsers) and [Edge](https://microsoftedge.microsoft.com/addons/detail/react-developer-tools/gpphkfbcpidddadnkolkpfckpihlkkil). + +> **Tip:** You can install the [React Developer Tools](https://react.dev/learn/react-developer-tools) browser extension to inspect components, their props and state. It might help you understand the application better and identify performance problems. It is available for [Firefox](https://addons.mozilla.org/en-US/firefox/addon/react-devtools/), [Chrome](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) (and compatible Chromium-based browsers) and [Edge](https://microsoftedge.microsoft.com/addons/detail/react-developer-tools/gpphkfbcpidddadnkolkpfckpihlkkil). ## Testing diff --git a/docs/contributing/pl-api.md b/docs/contributing/pl-api.md index 5ebaa541f..3318c3640 100644 --- a/docs/contributing/pl-api.md +++ b/docs/contributing/pl-api.md @@ -1,3 +1,9 @@ +--- +title: Contributing to pl-api +section: Contributing +order: 21 +--- + # Contributing to pl-api `pl-api` is a TypeScript library for interacting with Mastodon-compatible backends, focused on supporting multiple projects extending the official Mastodon API in incompatible ways. The goal of `pl-api` is to provide a unified, type-safe API for these backends. diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 0e13ffa78..000000000 --- a/docs/index.md +++ /dev/null @@ -1,3 +0,0 @@ -{% - include "../README.md" -%} diff --git a/docs/index.mdx b/docs/index.mdx new file mode 100644 index 000000000..01d40fbd8 --- /dev/null +++ b/docs/index.mdx @@ -0,0 +1,8 @@ +--- +title: Readme +order: 0 +--- + +import Readme from '../README.md'; + + diff --git a/docs/installing/iceshrimp.md b/docs/installing/iceshrimp.md index 20d81c333..fd4a73663 100644 --- a/docs/installing/iceshrimp.md +++ b/docs/installing/iceshrimp.md @@ -1,3 +1,9 @@ +--- +title: Iceshrimp.NET +section: Installing +order: 30 +--- + # Installing Nicolium as Iceshrimp.NET frontend Iceshrimp.NET does not have built-in support for alternative frontends. However, there are ways to use Nicolium as the frontend for Iceshrimp.NET by rerouting specific requests using a reverse proxy like Nginx. diff --git a/docs/installing/mitra.md b/docs/installing/mitra.md index 8d48ac959..d907aca01 100644 --- a/docs/installing/mitra.md +++ b/docs/installing/mitra.md @@ -1,3 +1,9 @@ +--- +title: Mitra +section: Installing +order: 31 +--- + # Installing Nicolium as Mitra frontend Installing Nicolium as a frontend for Mitra is no different from installing the default Mitra Web frontend. Just extract the Nicolium files into the directory specified in `config.yaml` under `web_client_dir`, by default `/usr/share/mitra/www`. diff --git a/docs/installing/pleroma-akkoma.md b/docs/installing/pleroma-akkoma.md index 1d6feabc9..ad9ab2858 100644 --- a/docs/installing/pleroma-akkoma.md +++ b/docs/installing/pleroma-akkoma.md @@ -1,3 +1,9 @@ +--- +title: Pleroma/Akkoma +section: Installing +order: 32 +--- + # Installing Nicolium as Pleroma/Akkoma frontend ## Installation in instance static directory diff --git a/docs/installing/standalone.md b/docs/installing/standalone.md index 6d2ecf7c6..fe569fc4d 100644 --- a/docs/installing/standalone.md +++ b/docs/installing/standalone.md @@ -1,3 +1,9 @@ +--- +title: Standalone +section: Installing +order: 33 +--- + # Standalone Nicolium installation To install Nicolium in standalone mode, allowing to sign in to any instance implementing Mastodon client API, you only need a static web server to serve the files. As usual on single page applications with client-side routing, the server must be configured to fallback to `index.html` for non-matching routes.