update docs for new website
Signed-off-by: nicole mikołajczyk <git@mkljczk.pl>
This commit is contained in:
@ -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`.
|
||||
|
||||
@ -1,6 +0,0 @@
|
||||
# Code of Conduct
|
||||
|
||||
{%
|
||||
include "../CODE_OF_CONDUCT.md"
|
||||
start='\n\n'
|
||||
%}
|
||||
9
docs/contributing/code-of-conduct.mdx
Normal file
9
docs/contributing/code-of-conduct.mdx
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Code of Conduct
|
||||
section: Contributing
|
||||
order: 22
|
||||
---
|
||||
|
||||
import CodeOfConduct from '../../CODE_OF_CONDUCT.md';
|
||||
|
||||
<CodeOfConduct />
|
||||
@ -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).
|
||||
<!-- TODO: turn those into tip/note again -->
|
||||
> **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
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
{%
|
||||
include "../README.md"
|
||||
%}
|
||||
8
docs/index.mdx
Normal file
8
docs/index.mdx
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Readme
|
||||
order: 0
|
||||
---
|
||||
|
||||
import Readme from '../README.md';
|
||||
|
||||
<Readme />
|
||||
@ -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.
|
||||
|
||||
@ -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`.
|
||||
|
||||
@ -1,3 +1,9 @@
|
||||
---
|
||||
title: Pleroma/Akkoma
|
||||
section: Installing
|
||||
order: 32
|
||||
---
|
||||
|
||||
# Installing Nicolium as Pleroma/Akkoma frontend
|
||||
|
||||
## Installation in instance static directory
|
||||
|
||||
@ -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.
|
||||
|
||||
Reference in New Issue
Block a user