Redone the entire docs site in astro

This commit is contained in:
Toastie 2023-12-11 15:52:37 +13:00
parent 0f75fa6e13
commit b4bdab80eb
No known key found for this signature in database
GPG key ID: FF47E5D4A3C8DC5E
112 changed files with 7946 additions and 8074 deletions

31
.gitignore vendored
View file

@ -1,20 +1,21 @@
# Dependencies
/node_modules
# build output
dist/
# generated types
.astro/
# Production
/build
# Generated files
.docusaurus
.cache-loader
# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
# dependencies
node_modules/
# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
# environment variables
.env
.env.production
# macOS-specific files
.DS_Store

4
.vscode/extensions.json vendored Normal file
View file

@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}

11
.vscode/launch.json vendored Normal file
View file

@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}

25
astro.config.mjs Normal file
View file

@ -0,0 +1,25 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: 'Valkyricoms docs',
social: {
github: 'https://toastielab.dev/Valkyriecoms/valkyrie-docs',
discord: 'https://discord.gg/y9KtEx7KFx',
},
sidebar: [
{
label: 'Guides',
autogenerate: { directory: 'guides' },
},
{
label: 'API',
autogenerate: { directory: 'api' },
},
],
}),
],
});

View file

@ -1,3 +0,0 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};

View file

@ -1,8 +0,0 @@
{
"label": "Api",
"position": 3,
"link": {
"type": "generated-index",
"description": "Here you can find our api docs."
}
}

View file

@ -1,43 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js)
## valkyrie-js package
## Classes
| Class | Description |
| --- | --- |
| [Stream](./valkyrie-js.stream) | |
## Abstract Classes
| Abstract Class | Description |
| --- | --- |
| [ChannelConnection](./valkyrie-js.channelconnection) | |
## Namespaces
| Namespace | Description |
| --- | --- |
| [api](./valkyrie-js.api) | |
| [entities](./valkyrie-js.entities) | |
## Variables
| Variable | Description |
| --- | --- |
| [ffVisibility](./valkyrie-js.ffvisibility) | |
| [mutedNoteReasons](./valkyrie-js.mutednotereasons) | |
| [noteVisibilities](./valkyrie-js.notevisibilities) | |
| [notificationTypes](./valkyrie-js.notificationtypes) | |
| [permissions](./valkyrie-js.permissions) | |
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [Acct](./valkyrie-js.acct) | |
| [Channels](./valkyrie-js.channels) | |
| [Endpoints](./valkyrie-js.endpoints) | |

View file

@ -1,8 +0,0 @@
{
"label": "Examples",
"position": 2,
"link": {
"type": "generated-index",
"description": "Here you can find any of our help articles."
}
}

View file

@ -1,11 +0,0 @@
---
sidebar_position: 1
slug: /
title: Welcome
tags:
- Welcome!
---
# What is valkyriecoms?
Valkyriecoms is a place where you can post pictures, chat with others, be yourself with out discrimination. This is the mission we have here at Valkyriecoms and Dragon's child studio (our parent group) if this is something you want to join come and join us at https://valkyriecoms.com.

View file

@ -1,106 +0,0 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Valkyriecoms docs',
tagline: 'Need help you have come to the right place!',
favicon: 'img/favicon.ico',
// Set the production url of your site here
url: 'https://docs.valkyriecoms.com',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/',
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'Valkyriecoms', // Usually your GitHub org/user name.
projectName: 'valkyrie-docs', // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'en',
locales: ['en'],
},
presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
routeBasePath: '/',
sidebarPath: require.resolve('./sidebars.js'),
},
blog: false,
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
navbar: {
title: 'Valkyriecoms docs',
logo: {
alt: 'Bygul',
src: 'img/Bygul.png',
},
items: [
{
href: 'https://toastielab.dev/Valkyriecoms/valkyrie-docs',
label: 'Toastielab',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Community',
items: [
{
label: 'Discord',
href: 'https://discord.com/invite/y9KtEx7KFx',
},
{
label: 'Valkyriecoms',
href: 'https://valkyriecoms.com',
},
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
href: 'https://toastielab.dev/Valkyriecoms/valkyrie-docs',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Dragon's child studios.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
};
module.exports = config;

7539
package-lock.json generated Normal file

File diff suppressed because it is too large Load diff

View file

@ -1,43 +1,17 @@
{
"name": "valkyriecoms-docs",
"version": "0.0.0",
"private": true,
"type": "module",
"version": "0.0.1",
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids"
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview",
"astro": "astro"
},
"dependencies": {
"@docusaurus/core": "2.4.1",
"@docusaurus/preset-classic": "2.4.1",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "2.4.1"
},
"browserslist": {
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"engines": {
"node": ">=16.14"
"@astrojs/starlight": "^0.15.0",
"astro": "^4.0.1",
"sharp": "^0.32.5"
}
}
}

View file

Before

Width:  |  Height:  |  Size: 4.2 KiB

After

Width:  |  Height:  |  Size: 4.2 KiB

15
public/favicon.svg Normal file
View file

@ -0,0 +1,15 @@
<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
width="32.000000pt" height="32.000000pt" viewBox="0 0 32.000000 32.000000"
preserveAspectRatio="xMidYMid meet">
<g transform="translate(0.000000,32.000000) scale(0.100000,-0.100000)"
fill="#000000" stroke="none">
<path d="M112 235 c-40 -34 -55 -81 -35 -113 14 -23 13 -26 -31 -67 -25 -23
-46 -45 -46 -49 0 -3 68 -6 150 -6 148 0 150 0 140 20 -6 12 -21 20 -35 20
-27 0 -32 9 -15 26 6 6 12 36 14 67 1 31 9 63 16 72 21 25 -9 47 -72 53 -47 4
-58 1 -86 -23z"/>
</g>
</svg>

After

Width:  |  Height:  |  Size: 674 B

View file

@ -1,33 +0,0 @@
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
// But you can create a sidebar manually
/*
tutorialSidebar: [
'intro',
'hello',
{
type: 'category',
label: 'Tutorial',
items: ['tutorial-basics/create-a-document'],
},
],
*/
};
module.exports = sidebars;

View file

Before

Width:  |  Height:  |  Size: 3.1 MiB

After

Width:  |  Height:  |  Size: 3.1 MiB

View file

@ -1,64 +0,0 @@
import React from 'react';
import clsx from 'clsx';
import styles from './styles.module.css';
const FeatureList = [
{
title: 'Easy to Use',
Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
description: (
<>
Docusaurus was designed from the ground up to be easily installed and
used to get your website up and running quickly.
</>
),
},
{
title: 'Focus on What Matters',
Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
description: (
<>
Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
ahead and move your docs into the <code>docs</code> directory.
</>
),
},
{
title: 'Powered by React',
Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
description: (
<>
Extend or customize your website layout by reusing React. Docusaurus can
be extended while reusing the same header and footer.
</>
),
},
];
function Feature({Svg, title, description}) {
return (
<div className={clsx('col col--4')}>
<div className="text--center">
<Svg className={styles.featureSvg} role="img" />
</div>
<div className="text--center padding-horiz--md">
<h3>{title}</h3>
<p>{description}</p>
</div>
</div>
);
}
export default function HomepageFeatures() {
return (
<section className={styles.features}>
<div className="container">
<div className="row">
{FeatureList.map((props, idx) => (
<Feature key={idx} {...props} />
))}
</div>
</div>
</section>
);
}

View file

@ -1,11 +0,0 @@
.features {
display: flex;
align-items: center;
padding: 2rem 0;
width: 100%;
}
.featureSvg {
height: 200px;
width: 200px;
}

7
src/content/config.ts Normal file
View file

@ -0,0 +1,7 @@
import { defineCollection } from 'astro:content';
import { docsSchema, i18nSchema } from '@astrojs/starlight/schema';
export const collections = {
docs: defineCollection({ schema: docsSchema() }),
i18n: defineCollection({ type: 'data', schema: i18nSchema() }),
};

View file

@ -1,10 +1,9 @@
---
sidebar_position: 2
slug: /api/index/
title: index
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index)
[Home](./index.md)
## API Reference

View file

@ -1,7 +1,5 @@
---
sidebar_position: 1
title: info
slug: /api
---
# About this section
@ -14,9 +12,8 @@ This part is currently under construction so things may not be complete yet
In this section of the documentation you will find the docs for the Valkyriecoms api which you can use by following the instructions on the [toastielab page](https://toastielab.dev/Valkyriecoms/-/packages/npm/valkyrie-js/0.0.24)
:::info
This part is meant for people who have some programming experience with [JavaScript](https://nodejs.org) but if you just want to browse around be our guest.
:::
:::

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-acct
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Acct](./valkyrie-js.acct)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-apiclient_constructor
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient) &gt; [(constructor)](./valkyrie-js.api.apiclient._constructor_)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-apii-client-credential
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient) &gt; [credential](./valkyrie-js.api.apiclient.credential)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-apiclient-fetch
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient) &gt; [fetch](./valkyrie-js.api.apiclient.fetch)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-apiclient
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-apiclient-origin
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient) &gt; [origin](./valkyrie-js.api.apiclient.origin)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-apiclient-request
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient) &gt; [request](./valkyrie-js.api.apiclient.request)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-api-apierror
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIError](./valkyrie-js.api.apierror)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-api-fetchlike
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [FetchLike](./valkyrie-js.api.fetchlike)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-api-isapierror
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [isAPIError](./valkyrie-js.api.isapierror)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-api
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-channelconnection-constructor
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [(constructor)](./valkyrie-js.channelconnection._constructor_)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-channelconnection-channel
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [channel](./valkyrie-js.channelconnection.channel)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-channelconnection-dispose
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [dispose](./valkyrie-js.channelconnection.dispose)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-channelconnection-id
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [id](./valkyrie-js.channelconnection.id)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-channelconnection-incount
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [inCount](./valkyrie-js.channelconnection.incount)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-channelconnection
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-channelconnection-name
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [name](./valkyrie-js.channelconnection.name)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-channelconnection-outcount
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [outCount](./valkyrie-js.channelconnection.outcount)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-channelconnection-send
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [send](./valkyrie-js.channelconnection.send)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-channelconnection-stream
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [stream](./valkyrie-js.channelconnection.stream)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-channels
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Channels](./valkyrie-js.channels)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-endpoints
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Endpoints](./valkyrie-js.endpoints)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-ad
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Ad](./valkyrie-js.entities.ad)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-announcement
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Announcement](./valkyrie-js.entities.announcement)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-antenna
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Antenna](./valkyrie-js.entities.antenna)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-app
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [App](./valkyrie-js.entities.app)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-authsession
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [AuthSession](./valkyrie-js.entities.authsession)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-blocking
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Blocking](./valkyrie-js.entities.blocking)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-channel
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Channel](./valkyrie-js.entities.channel)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-clip
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Clip](./valkyrie-js.entities.clip)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-customemoji
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [CustomEmoji](./valkyrie-js.entities.customemoji)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-datestring
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [DateString](./valkyrie-js.entities.datestring)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-detailedinstancemetadata
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [DetailedInstanceMetadata](./valkyrie-js.entities.detailedinstancemetadata)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-drivefile
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [DriveFile](./valkyrie-js.entities.drivefile)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-drivefolder
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [DriveFolder](./valkyrie-js.entities.drivefolder)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-following
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Following](./valkyrie-js.entities.following)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-followingfolloweepopulated
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [FollowingFolloweePopulated](./valkyrie-js.entities.followingfolloweepopulated)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-followingfollowerpopulated
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [FollowingFollowerPopulated](./valkyrie-js.entities.followingfollowerpopulated)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-followrequest
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [FollowRequest](./valkyrie-js.entities.followrequest)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-gallerypost
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [GalleryPost](./valkyrie-js.entities.gallerypost)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-id
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [ID](./valkyrie-js.entities.id)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-instance
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Instance](./valkyrie-js.entities.instance)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-instancemetadata
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [InstanceMetadata](./valkyrie-js.entities.instancemetadata)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-liteinstancemetadata
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./indexgt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [LiteInstanceMetadata](./valkyrie-js.entities.liteinstancemetadata)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-metadata
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [MeDetailed](./valkyrie-js.entities.medetailed)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-messagingmessage
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [MessagingMessage](./valkyrie-js.entities.messagingmessage)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-note
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Note](./valkyrie-js.entities.note)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-notefavorite
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [NoteFavorite](./valkyrie-js.entities.notefavorite)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-notereaction
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [NoteReaction](./valkyrie-js.entities.notereaction)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-notification
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Notification](./valkyrie-js.entities.notification)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-origintype
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [OriginType](./valkyrie-js.entities.origintype)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-page
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Page](./valkyrie-js.entities.page)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-pageevent
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [PageEvent](./valkyrie-js.entities.pageevent)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-serverinfo
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [ServerInfo](./valkyrie-js.entities.serverinfo)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-signin
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Signin](./valkyrie-js.entities.signin)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-stats
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Stats](./valkyrie-js.entities.stats)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-user
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [User](./valkyrie-js.entities.user)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-userdetailed
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [UserDetailed](./valkyrie-js.entities.userdetailed)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-usergroup
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [UserGroup](./valkyrie-js.entities.usergroup)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-userlist
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [UserList](./valkyrie-js.entities.userlist)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-userlite
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [UserLite](./valkyrie-js.entities.userlite)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-entities-usersorting
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [UserSorting](./valkyrie-js.entities.usersorting)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-ffvisibility
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ffVisibility](./valkyrie-js.ffvisibility)

View file

@ -0,0 +1,46 @@
---
title: valkyrie-js
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js)
## valkyrie-js package
## Classes
| Class | Description |
| -------------------------------- | ----------- |
| [Stream](/valkyrie-js.stream.md) | |
## Abstract Classes
| Abstract Class | Description |
| ------------------------------------------------------ | ----------- |
| [ChannelConnection](/valkyrie-js.channelconnection.md) | |
## Namespaces
| Namespace | Description |
| --------------------------------------- | ----------- |
| [api](/valkyrie-js.api.md) | |
| [entities](/valkyrie-js.entities.ad.md) | |
## Variables
| Variable | Description |
| ------------------------------------------------------ | ----------- |
| [ffVisibility](/valkyrie-js.ffvisibility.md) | |
| [mutedNoteReasons](/valkyrie-js.mutednotereasons.md) | |
| [noteVisibilities](/valkyrie-js.notevisibilities.md) | |
| [notificationTypes](/valkyrie-js.notificationtypes.md) | |
| [permissions](/valkyrie-js.permissions.md) | |
## Type Aliases
| Type Alias | Description |
| -------------------------------------- | ----------- |
| [Acct](/valkyrie-js.acct.md) | |
| [Channels](/valkyrie-js.channels.md) | |
| [Endpoints](/valkyrie-js.endpoints.md) | |

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-mutednotereasons
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [mutedNoteReasons](./valkyrie-js.mutednotereasons)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-notevisibilities
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [noteVisibilities](./valkyrie-js.notevisibilities)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-notificationtypes
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [notificationTypes](./valkyrie-js.notificationtypes)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-permissions
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [permissions](./valkyrie-js.permissions)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-stream-constructor
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [(constructor)](./valkyrie-js.stream._constructor_)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-stream-close
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [close](./valkyrie-js.stream.close)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-stream-disconnecttochannel
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [disconnectToChannel](./valkyrie-js.stream.disconnecttochannel)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-stream
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-stream-removesharedconnection
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [removeSharedConnection](./valkyrie-js.stream.removesharedconnection)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-stream-removesharedconnectionpool
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [removeSharedConnectionPool](./valkyrie-js.stream.removesharedconnectionpool)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-stream-send
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [send](./valkyrie-js.stream.send)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-stream-state
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [state](./valkyrie-js.stream.state)

View file

@ -1,3 +1,6 @@
---
title: valkyrie-js-stream-usechannel
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [useChannel](./valkyrie-js.stream.usechannel)

Some files were not shown because too many files have changed in this diff Show more